Package com.oracle.bmc.disasterrecovery.requests

Class ListWorkRequestsRequest.Builder

java.lang.Object

com.oracle.bmc.disasterrecovery.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	Description
Builder()

Method Summary

Modifier and Type	Method	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 ID (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)	For list pagination.
ListWorkRequestsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListWorkRequestsRequest.Builder	page(String page)	For list pagination.
ListWorkRequestsRequest.Builder	resourceId(String resourceId)	The ID (OCID) of the resource affected by the work request.
ListWorkRequestsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListWorkRequestsRequest.Builder	sortBy(ListWorkRequestsRequest.SortBy sortBy)	The field to sort by.
ListWorkRequestsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListWorkRequestsRequest.Builder	status(OperationStatus status)	A filter to return only resources whose lifecycleState matches the given OperationStatus.
ListWorkRequestsRequest.Builder	workRequestId(String workRequestId)	The ID (OCID) of the asynchronous work request.

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 ID (OCID) of the compartment in which to list resources.

Example: ocid1.compartment.oc1..uniqueID

Parameters:

compartmentId - the value to set

Returns:

this builder instance

workRequestId

public ListWorkRequestsRequest.Builder workRequestId(String workRequestId)

The ID (OCID) of the asynchronous work request.

Example: ocid1.workrequest.oc1..uniqueID

Parameters:

workRequestId - the value to set

Returns:

this builder instance

status

public ListWorkRequestsRequest.Builder status(OperationStatus status)

A filter to return only resources whose lifecycleState matches the given OperationStatus.

Parameters:

status - the value to set

Returns:

this builder instance

resourceId

public ListWorkRequestsRequest.Builder resourceId(String resourceId)

The ID (OCID) of the resource affected by the work request.

Example: ocid1.drplanexecution.oc1..uniqueID

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)

For list pagination.

The value of the opc-next-page response header from the previous “List” call.

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListWorkRequestsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 1000 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: 100

Parameters:

limit - the value to set

Returns:

this builder instance

sortOrder

public ListWorkRequestsRequest.Builder sortOrder(SortOrder 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)

The field to sort by.

Only one sort order may be provided. Default order for timeAccepted is descending.

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