com.oracle.bmc.core.requests

Class ListBlockVolumeReplicasRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListBlockVolumeReplicasRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListBlockVolumeReplicasRequest,Void>

Enclosing class:

ListBlockVolumeReplicasRequest

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

Method Summary

Modifier and Type	Method and Description
ListBlockVolumeReplicasRequest.Builder	availabilityDomain(String availabilityDomain) The name of the availability domain.
ListBlockVolumeReplicasRequest	build() Build the instance of ListBlockVolumeReplicasRequest as configured by this builder
ListBlockVolumeReplicasRequest	buildWithoutInvocationCallback()
ListBlockVolumeReplicasRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListBlockVolumeReplicasRequest.Builder	copy(ListBlockVolumeReplicasRequest o) Copy method to populate the builder with values from the given instance.
ListBlockVolumeReplicasRequest.Builder	displayName(String displayName) A filter to return only resources that match the given display name exactly.
ListBlockVolumeReplicasRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListBlockVolumeReplicasRequest.Builder	lifecycleState(BlockVolumeReplica.LifecycleState lifecycleState) A filter to only return resources that match the given lifecycle state.
ListBlockVolumeReplicasRequest.Builder	limit(Integer limit) For list pagination.
ListBlockVolumeReplicasRequest.Builder	page(String page) For list pagination.
ListBlockVolumeReplicasRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListBlockVolumeReplicasRequest.Builder	sortBy(ListBlockVolumeReplicasRequest.SortBy sortBy) The field to sort by.
ListBlockVolumeReplicasRequest.Builder	sortOrder(ListBlockVolumeReplicasRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

invocationCallback

public ListBlockVolumeReplicasRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListBlockVolumeReplicasRequest.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 ListBlockVolumeReplicasRequest.Builder copy(ListBlockVolumeReplicasRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListBlockVolumeReplicasRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListBlockVolumeReplicasRequest build()

Build the instance of ListBlockVolumeReplicasRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListBlockVolumeReplicasRequest,Void>

Returns:

instance of ListBlockVolumeReplicasRequest

availabilityDomain

public ListBlockVolumeReplicasRequest.Builder availabilityDomain(String availabilityDomain)

The name of the availability domain.

Example: Uocm:PHX-AD-1

Returns:

this.

compartmentId

public ListBlockVolumeReplicasRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Returns:

this.

limit

public ListBlockVolumeReplicasRequest.Builder limit(Integer limit)

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

Example: 50

Returns:

this.

page

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

Returns:

this.

displayName

public ListBlockVolumeReplicasRequest.Builder displayName(String displayName)

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

Returns:

this.

sortBy

public ListBlockVolumeReplicasRequest.Builder sortBy(ListBlockVolumeReplicasRequest.SortBy sortBy)

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Returns:

this.

sortOrder

public ListBlockVolumeReplicasRequest.Builder sortOrder(ListBlockVolumeReplicasRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Returns:

this.

lifecycleState

public ListBlockVolumeReplicasRequest.Builder lifecycleState(BlockVolumeReplica.LifecycleState lifecycleState)

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:

this.

buildWithoutInvocationCallback

public ListBlockVolumeReplicasRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object