Package com.oracle.bmc.datasafe.requests

Class ListWorkRequestsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.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.Builder	accessLevel(ListWorkRequestsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
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)	A filter to return only resources that match the specified compartment OCID.
ListWorkRequestsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
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)	Unique identifier for the request.
ListWorkRequestsRequest.Builder	operationType(String operationType)	A filter to return only work requests that match the specific operation type.
ListWorkRequestsRequest.Builder	page(String page)	For list pagination.
ListWorkRequestsRequest.Builder	resourceId(String resourceId)	A filter to return only work requests that match the specified resource OCID.
ListWorkRequestsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListWorkRequestsRequest.Builder	sortBy(ListWorkRequestsRequest.SortBy sortBy)	The field used for sorting.
ListWorkRequestsRequest.Builder	sortOrder(ListWorkRequestsRequest.SortOrder sortOrder)	The sorting order for the work requests, either ascending (ASC) or descending (DESC).
ListWorkRequestsRequest.Builder	targetDatabaseId(String targetDatabaseId)	A filter to return only work requests that are associated to the specified target database OCID.

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)

A filter to return only resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

operationType

public ListWorkRequestsRequest.Builder operationType(String operationType)

A filter to return only work requests that match the specific operation type.

Parameters:

operationType - the value to set

Returns:

this builder instance

sortBy

public ListWorkRequestsRequest.Builder sortBy(ListWorkRequestsRequest.SortBy sortBy)

The field used for sorting.

Only one sorting parameter can be specified. The default order is descending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListWorkRequestsRequest.Builder sortOrder(ListWorkRequestsRequest.SortOrder sortOrder)

The sorting order for the work requests, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

resourceId

public ListWorkRequestsRequest.Builder resourceId(String resourceId)

A filter to return only work requests that match the specified resource OCID.

Parameters:

resourceId - the value to set

Returns:

this builder instance

targetDatabaseId

public ListWorkRequestsRequest.Builder targetDatabaseId(String targetDatabaseId)

A filter to return only work requests that are associated to the specified target database OCID.

Parameters:

targetDatabaseId - the value to set

Returns:

this builder instance

opcRequestId

public ListWorkRequestsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

page

public ListWorkRequestsRequest.Builder page(String page)

For list pagination.

The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListWorkRequestsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListWorkRequestsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false.

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListWorkRequestsRequest.Builder accessLevel(ListWorkRequestsRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE.

Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Parameters:

accessLevel - 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