Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListSnapshotsRequest

example

Click here to see how to use ListSnapshotsRequest.

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment.

Optional fileSystemId

fileSystemId: undefined | string

The OCID of the file system.

Optional filesystemSnapshotPolicyId

filesystemSnapshotPolicyId: undefined | string

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

Optional id

id: undefined | string

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

Optional lifecycleState

lifecycleState: LifecycleState

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

Optional limit

limit: undefined | number

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: {@code 100}

Optional opcRequestId

opcRequestId: undefined | string

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

Optional page

page: undefined | string

For list pagination. The value of the {@code 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).

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortOrder

sortOrder: SortOrder

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.