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.

Constructor Summary

Constructors

Constructor and Description
ListSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
static ListSnapshotsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The OCID of the compartment.
String	getFileSystemId() The OCID of the file system.
String	getFilesystemSnapshotPolicyId() The OCID of the file system snapshot policy that is used to create the snapshots.
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.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListSnapshotsRequest.Builder	toBuilder() Return an instance of ListSnapshotsRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSnapshotsRequest

public ListSnapshotsRequest()

Method Detail

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.

getFilesystemSnapshotPolicyId

public String getFilesystemSnapshotPolicyId()

The OCID of the file system snapshot policy that is used to create the snapshots.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getFileSystemId

public String getFileSystemId()

The OCID of the file system.

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.

toBuilder

public ListSnapshotsRequest.Builder toBuilder()

Return an instance of ListSnapshotsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListSnapshotsRequest.Builder that allows you to modify request properties.

builder

public static ListSnapshotsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>