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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/filestorage/ListSnapshotsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSnapshotsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListSnapshotsRequest.Builderstatic classListSnapshotsRequest.LifecycleStateFilter results by the specified lifecycle state.static classListSnapshotsRequest.SortOrderThe sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.
-
Constructor Summary
Constructors Constructor Description ListSnapshotsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListSnapshotsRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetCompartmentId()The OCID of the compartment.StringgetFileSystemId()The OCID of the file system.StringgetFilesystemSnapshotPolicyId()The OCID of the file system snapshot policy that is used to create the snapshots.StringgetId()Filter results by OCID.ListSnapshotsRequest.LifecycleStategetLifecycleState()Filter results by the specified lifecycle state.IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.ListSnapshotsRequest.SortOrdergetSortOrder()The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListSnapshotsRequest.BuildertoBuilder()Return an instance ofListSnapshotsRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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.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.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.
-
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 ofListSnapshotsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListSnapshotsRequest.Builderthat 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
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-