Class DescribeSnapshotsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the inputs for the DescribeSnapshots operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The identifier of the directory for which to retrieve snapshot information.getLimit()
The maximum number of objects to return.The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.A list of identifiers of the snapshots to obtain the information for.int
hashCode()
void
setDirectoryId
(String directoryId) The identifier of the directory for which to retrieve snapshot information.void
The maximum number of objects to return.void
setNextToken
(String nextToken) The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.void
setSnapshotIds
(Collection<String> snapshotIds) A list of identifiers of the snapshots to obtain the information for.toString()
Returns a string representation of this object; useful for testing and debugging.withDirectoryId
(String directoryId) The identifier of the directory for which to retrieve snapshot information.The maximum number of objects to return.withNextToken
(String nextToken) The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.withSnapshotIds
(String... snapshotIds) A list of identifiers of the snapshots to obtain the information for.withSnapshotIds
(Collection<String> snapshotIds) A list of identifiers of the snapshots to obtain the information for.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeSnapshotsRequest
public DescribeSnapshotsRequest()
-
-
Method Details
-
setDirectoryId
The identifier of the directory for which to retrieve snapshot information.
- Parameters:
directoryId
- The identifier of the directory for which to retrieve snapshot information.
-
getDirectoryId
The identifier of the directory for which to retrieve snapshot information.
- Returns:
- The identifier of the directory for which to retrieve snapshot information.
-
withDirectoryId
The identifier of the directory for which to retrieve snapshot information.
- Parameters:
directoryId
- The identifier of the directory for which to retrieve snapshot information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSnapshotIds
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
- Returns:
- A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
-
setSnapshotIds
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
- Parameters:
snapshotIds
- A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
-
withSnapshotIds
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
NOTE: This method appends the values to the existing list (if any). Use
setSnapshotIds(java.util.Collection)
orwithSnapshotIds(java.util.Collection)
if you want to override the existing values.- Parameters:
snapshotIds
- A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSnapshotIds
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
- Parameters:
snapshotIds
- A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
- Parameters:
nextToken
- The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
-
getNextToken
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
- Returns:
- The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
-
withNextToken
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
- Parameters:
nextToken
- The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of objects to return.
- Parameters:
limit
- The maximum number of objects to return.
-
getLimit
The maximum number of objects to return.
- Returns:
- The maximum number of objects to return.
-
withLimit
The maximum number of objects to return.
- Parameters:
limit
- The maximum number of objects to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-