Package com.oracle.bmc.disasterrecovery.requests

Class ListDrPlansRequest.Builder

java.lang.Object

com.oracle.bmc.disasterrecovery.requests.ListDrPlansRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDrPlansRequest,Void>

Enclosing class:

ListDrPlansRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListDrPlansRequest	build()	Build the instance of ListDrPlansRequest as configured by this builder
ListDrPlansRequest	buildWithoutInvocationCallback()	Build the instance of ListDrPlansRequest as configured by this builder
ListDrPlansRequest.Builder	copy(ListDrPlansRequest o)	Copy method to populate the builder with values from the given instance.
ListDrPlansRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name.
ListDrPlansRequest.Builder	drPlanId(String drPlanId)	The OCID of the DR plan.
ListDrPlansRequest.Builder	drPlanType(DrPlanType drPlanType)	The DR plan type.
ListDrPlansRequest.Builder	drProtectionGroupId(String drProtectionGroupId)	The OCID of the DR protection group.
ListDrPlansRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListDrPlansRequest.Builder	lifecycleState(DrPlanLifecycleState lifecycleState)	A filter to return only DR plans that match the given lifecycle state.
ListDrPlansRequest.Builder	lifecycleSubState(DrPlanLifecycleSubState lifecycleSubState)	A filter to return only DR plans that match the given lifecycle sub-state.
ListDrPlansRequest.Builder	limit(Integer limit)	For list pagination.
ListDrPlansRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListDrPlansRequest.Builder	page(String page)	For list pagination.
ListDrPlansRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListDrPlansRequest.Builder	sortBy(ListDrPlansRequest.SortBy sortBy)	The field to sort by.
ListDrPlansRequest.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

drProtectionGroupId

public ListDrPlansRequest.Builder drProtectionGroupId(String drProtectionGroupId)

The OCID of the DR protection group.

Mandatory query param.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Parameters:

drProtectionGroupId - the value to set

Returns:

this builder instance

lifecycleState

public ListDrPlansRequest.Builder lifecycleState(DrPlanLifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

drPlanId

public ListDrPlansRequest.Builder drPlanId(String drPlanId)

The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Parameters:

drPlanId - the value to set

Returns:

this builder instance

drPlanType

public ListDrPlansRequest.Builder drPlanType(DrPlanType drPlanType)

The DR plan type.

Parameters:

drPlanType - the value to set

Returns:

this builder instance

displayName

public ListDrPlansRequest.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 ListDrPlansRequest.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 ListDrPlansRequest.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 ListDrPlansRequest.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 ListDrPlansRequest.Builder sortBy(ListDrPlansRequest.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 ListDrPlansRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

lifecycleSubState

public ListDrPlansRequest.Builder lifecycleSubState(DrPlanLifecycleSubState lifecycleSubState)

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

Parameters:

lifecycleSubState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListDrPlansRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDrPlansRequest build()

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

Returns:

instance of ListDrPlansRequest

buildWithoutInvocationCallback

public ListDrPlansRequest buildWithoutInvocationCallback()

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