com.oracle.bmc.filestorage.requests

Class ListSnapshotsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.filestorage.requests.ListSnapshotsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public class ListSnapshotsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListSnapshotsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListSnapshotsRequest.Builder
static class	ListSnapshotsRequest.LifecycleState Filter results by the specified lifecycle state.
static class	ListSnapshotsRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.

Method Summary

Modifier and Type	Method and Description
static ListSnapshotsRequest.Builder	builder()
String	getFileSystemId() The OCID of the file system.
String	getId() Filter results by OCID.
ListSnapshotsRequest.LifecycleState	getLifecycleState() Filter results by the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
ListSnapshotsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.

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

getBody$, 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 ListSnapshotsRequest.Builder builder()

getFileSystemId

public String getFileSystemId()

The OCID of the file system.

getLimit

public Integer getLimit()

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: `100`

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](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

getLifecycleState

public ListSnapshotsRequest.LifecycleState getLifecycleState()

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getId

public String getId()

Filter results by OCID. Must be an OCID of the correct type for the resouce type.

getSortOrder

public ListSnapshotsRequest.SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending. The default order is ‘desc’ except for numeric values.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.