com.oracle.bmc.core.requests

Class ListVolumesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest

com.oracle.bmc.core.requests.ListVolumesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListVolumesRequest
extends BmcRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListVolumesRequest.Builder
static class	ListVolumesRequest.SortBy The field to sort by.
static class	ListVolumesRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListVolumesRequest.Builder	builder()
String	getAvailabilityDomain() The name of the availability domain.
String	getCompartmentId() The OCID of the compartment.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
Volume.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() For list pagination.
String	getPage() For list pagination.
ListVolumesRequest.SortBy	getSortBy() The field to sort by.
ListVolumesRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getVolumeGroupId() The OCID of the volume group.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ListVolumesRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: Uocm:PHX-AD-1

getLimit

public Integer getLimit()

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

getPage

public String getPage()

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.

getDisplayName

public String getDisplayName()

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

getSortBy

public ListVolumesRequest.SortBy getSortBy()

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.

getSortOrder

public ListVolumesRequest.SortOrder getSortOrder()

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

getVolumeGroupId

public String getVolumeGroupId()

The OCID of the volume group.

getLifecycleState

public Volume.LifecycleState getLifecycleState()

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