com.oracle.bmc.rover.requests

Class ListWorkRequestsRequest.Builder

java.lang.Object

com.oracle.bmc.rover.requests.ListWorkRequestsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListWorkRequestsRequest,Void>

Enclosing class:

ListWorkRequestsRequest

public static class ListWorkRequestsRequest.Builder
extends Object
implements BmcRequest.Builder<ListWorkRequestsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListWorkRequestsRequest	build() Build the instance of ListWorkRequestsRequest as configured by this builder
ListWorkRequestsRequest	buildWithoutInvocationCallback() Build the instance of ListWorkRequestsRequest as configured by this builder
ListWorkRequestsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment in which to list resources.
ListWorkRequestsRequest.Builder	copy(ListWorkRequestsRequest o) Copy method to populate the builder with values from the given instance.
ListWorkRequestsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListWorkRequestsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListWorkRequestsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListWorkRequestsRequest.Builder	operationType(WorkRequestOperationType operationType) Filter results by the type of the operation associated with the work request.
ListWorkRequestsRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListWorkRequestsRequest.Builder	resourceId(String resourceId) Filter work requests by the resource ocid.
ListWorkRequestsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListWorkRequestsRequest.Builder	sortBy(ListWorkRequestsRequest.SortBy sortBy) Specifies the field to sort by.
ListWorkRequestsRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ‘asc’ or ‘desc’.
ListWorkRequestsRequest.Builder	status(WorkRequestOperationStatus status) Filter results by work request status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListWorkRequestsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

operationType

public ListWorkRequestsRequest.Builder operationType(WorkRequestOperationType operationType)

Filter results by the type of the operation associated with the work request.

Parameters:

operationType - the value to set

Returns:

this builder instance

status

public ListWorkRequestsRequest.Builder status(WorkRequestOperationStatus status)

Filter results by work request status.

Parameters:

status - the value to set

Returns:

this builder instance

resourceId

public ListWorkRequestsRequest.Builder resourceId(String resourceId)

Filter work requests by the resource ocid.

Parameters:

resourceId - the value to set

Returns:

this builder instance

opcRequestId

public ListWorkRequestsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

page

public ListWorkRequestsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListWorkRequestsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

sortOrder

public ListWorkRequestsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListWorkRequestsRequest.Builder sortBy(ListWorkRequestsRequest.SortBy sortBy)

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListWorkRequestsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListWorkRequestsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListWorkRequestsRequest.Builder copy(ListWorkRequestsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListWorkRequestsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListWorkRequestsRequest build()

Build the instance of ListWorkRequestsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListWorkRequestsRequest,Void>

Returns:

instance of ListWorkRequestsRequest

buildWithoutInvocationCallback

public ListWorkRequestsRequest buildWithoutInvocationCallback()

Build the instance of ListWorkRequestsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListWorkRequestsRequest