Package com.oracle.bmc.disasterrecovery.requests

Class ListDrProtectionGroupsRequest.Builder

java.lang.Object

com.oracle.bmc.disasterrecovery.requests.ListDrProtectionGroupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDrProtectionGroupsRequest,Void>

Enclosing class:

ListDrProtectionGroupsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListDrProtectionGroupsRequest	build()	Build the instance of ListDrProtectionGroupsRequest as configured by this builder
ListDrProtectionGroupsRequest	buildWithoutInvocationCallback()	Build the instance of ListDrProtectionGroupsRequest as configured by this builder
ListDrProtectionGroupsRequest.Builder	compartmentId(String compartmentId)	The ID (OCID) of the compartment in which to list resources.
ListDrProtectionGroupsRequest.Builder	copy(ListDrProtectionGroupsRequest o)	Copy method to populate the builder with values from the given instance.
ListDrProtectionGroupsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name.
ListDrProtectionGroupsRequest.Builder	drProtectionGroupId(String drProtectionGroupId)	The OCID of the DR protection group.
ListDrProtectionGroupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListDrProtectionGroupsRequest.Builder	lifecycleState(DrProtectionGroupLifecycleState lifecycleState)	A filter to return only DR protection groups that match the given lifecycle state.
ListDrProtectionGroupsRequest.Builder	lifecycleSubState(DrProtectionGroupLifecycleSubState lifecycleSubState)	A filter to return only DR protection groups that match the given lifecycle sub-state.
ListDrProtectionGroupsRequest.Builder	limit(Integer limit)	For list pagination.
ListDrProtectionGroupsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListDrProtectionGroupsRequest.Builder	page(String page)	For list pagination.
ListDrProtectionGroupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListDrProtectionGroupsRequest.Builder	role(DrProtectionGroupRole role)	The DR protection group Role.
ListDrProtectionGroupsRequest.Builder	sortBy(ListDrProtectionGroupsRequest.SortBy sortBy)	The field to sort by.
ListDrProtectionGroupsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.

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 ListDrProtectionGroupsRequest.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

lifecycleState

public ListDrProtectionGroupsRequest.Builder lifecycleState(DrProtectionGroupLifecycleState lifecycleState)

A filter to return only DR protection groups that match the given lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

drProtectionGroupId

public ListDrProtectionGroupsRequest.Builder drProtectionGroupId(String drProtectionGroupId)

The OCID of the DR protection group.

Optional query param.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Parameters:

drProtectionGroupId - the value to set

Returns:

this builder instance

displayName

public ListDrProtectionGroupsRequest.Builder displayName(String displayName)

A filter to return only resources that match the given display name.

Example: MyResourceDisplayName

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListDrProtectionGroupsRequest.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

page

public ListDrProtectionGroupsRequest.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

sortOrder

public ListDrProtectionGroupsRequest.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 ListDrProtectionGroupsRequest.Builder sortBy(ListDrProtectionGroupsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Example: MyResourceDisplayName

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListDrProtectionGroupsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

role

public ListDrProtectionGroupsRequest.Builder role(DrProtectionGroupRole role)

The DR protection group Role.

Parameters:

role - the value to set

Returns:

this builder instance

lifecycleSubState

public ListDrProtectionGroupsRequest.Builder lifecycleSubState(DrProtectionGroupLifecycleSubState lifecycleSubState)

A filter to return only DR protection groups that match the given lifecycle sub-state.

Parameters:

lifecycleSubState - the value to set

Returns:

this builder instance

invocationCallback

public ListDrProtectionGroupsRequest.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 ListDrProtectionGroupsRequest.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 ListDrProtectionGroupsRequest.Builder copy(ListDrProtectionGroupsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListDrProtectionGroupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDrProtectionGroupsRequest build()

Build the instance of ListDrProtectionGroupsRequest 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<ListDrProtectionGroupsRequest,Void>

Returns:

instance of ListDrProtectionGroupsRequest

buildWithoutInvocationCallback

public ListDrProtectionGroupsRequest buildWithoutInvocationCallback()

Build the instance of ListDrProtectionGroupsRequest 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 ListDrProtectionGroupsRequest