@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ListVolumesRequest extends BmcRequest<Void>
Example: Click here to see how to use ListVolumesRequest.
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 ). |
Modifier and Type | Method and Description |
---|---|
static ListVolumesRequest.Builder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o)
Uses getInvocationCallback and getRetryConfiguration to determine if passed
request is equal to ‘this’.
|
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.
|
int |
hashCode()
Uses invocationCallback and retryConfiguration to generate a hash.
|
ListVolumesRequest.Builder |
toBuilder() |
String |
toString() |
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
public static ListVolumesRequest.Builder builder()
public ListVolumesRequest.Builder toBuilder()
public boolean equals(Object o)
BmcRequest
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
equals
in class BmcRequest<Void>
protected boolean canEqual(Object other)
public int hashCode()
BmcRequest
Uses invocationCallback and retryConfiguration to generate a hash.
hashCode
in class BmcRequest<Void>
public String getAvailabilityDomain()
The name of the availability domain.
Example: Uocm:PHX-AD-1
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
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.
public String getDisplayName()
A filter to return only resources that match the given display name exactly.
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.
public ListVolumesRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC
) or descending (DESC
). The DISPLAYNAME sort order
is case sensitive.
public String getVolumeGroupId()
The OCID of the volume group.
public Volume.LifecycleState getLifecycleState()
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
Copyright © 2016–2022. All rights reserved.