Package com.oracle.bmc.core.requests

Class ListVolumesRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListVolumesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListVolumesRequest,Void>

Enclosing class:

ListVolumesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListVolumesRequest.Builder	availabilityDomain(String availabilityDomain)	The name of the availability domain.
ListVolumesRequest	build()	Build the instance of ListVolumesRequest as configured by this builder
ListVolumesRequest	buildWithoutInvocationCallback()	Build the instance of ListVolumesRequest as configured by this builder
ListVolumesRequest.Builder	clusterPlacementGroupId(String clusterPlacementGroupId)	A filter to return only resources that match the given cluster placement group Id exactly.
ListVolumesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListVolumesRequest.Builder	copy(ListVolumesRequest o)	Copy method to populate the builder with values from the given instance.
ListVolumesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListVolumesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListVolumesRequest.Builder	lifecycleState(Volume.LifecycleState lifecycleState)	A filter to only return resources that match the given lifecycle state.
ListVolumesRequest.Builder	limit(Integer limit)	For list pagination.
ListVolumesRequest.Builder	page(String page)	For list pagination.
ListVolumesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListVolumesRequest.Builder	sortBy(ListVolumesRequest.SortBy sortBy)	The field to sort by.
ListVolumesRequest.Builder	sortOrder(ListVolumesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListVolumesRequest.Builder	volumeGroupId(String volumeGroupId)	The OCID of the volume group.

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

availabilityDomain

public ListVolumesRequest.Builder availabilityDomain(String availabilityDomain)

The name of the availability domain.

Example: Uocm:PHX-AD-1

Parameters:

availabilityDomain - the value to set

Returns:

this builder instance

compartmentId

public ListVolumesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

Parameters:

page - the value to set

Returns:

this builder instance

displayName

public ListVolumesRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListVolumesRequest.Builder sortBy(ListVolumesRequest.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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListVolumesRequest.Builder sortOrder(ListVolumesRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

The DISPLAYNAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

volumeGroupId

public ListVolumesRequest.Builder volumeGroupId(String volumeGroupId)

The OCID of the volume group.

Parameters:

volumeGroupId - the value to set

Returns:

this builder instance

clusterPlacementGroupId

public ListVolumesRequest.Builder clusterPlacementGroupId(String clusterPlacementGroupId)

A filter to return only resources that match the given cluster placement group Id exactly.

Parameters:

clusterPlacementGroupId - the value to set

Returns:

this builder instance

lifecycleState

public ListVolumesRequest.Builder lifecycleState(Volume.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListVolumesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListVolumesRequest build()

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

Returns:

instance of ListVolumesRequest

buildWithoutInvocationCallback

public ListVolumesRequest buildWithoutInvocationCallback()

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