Class DescribeSnapshotsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.directory.model.DescribeSnapshotsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the inputs for the DescribeSnapshots operation.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeSnapshotsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeSnapshotsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDirectoryId()
The identifier of the directory for which to retrieve snapshot information.Integer
getLimit()
The maximum number of objects to return.String
getNextToken()
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.List<String>
getSnapshotIds()
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
setLimit(Integer limit)
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeSnapshotsRequest
withDirectoryId(String directoryId)
The identifier of the directory for which to retrieve snapshot information.DescribeSnapshotsRequest
withLimit(Integer limit)
The maximum number of objects to return.DescribeSnapshotsRequest
withNextToken(String nextToken)
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.DescribeSnapshotsRequest
withSnapshotIds(String... snapshotIds)
A list of identifiers of the snapshots to obtain the information for.DescribeSnapshotsRequest
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
-
-
-
-
Method Detail
-
setDirectoryId
public void setDirectoryId(String directoryId)
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
public String 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
public DescribeSnapshotsRequest withDirectoryId(String directoryId)
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
public List<String> 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
public void setSnapshotIds(Collection<String> 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.
- 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
public DescribeSnapshotsRequest withSnapshotIds(String... 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.
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
public DescribeSnapshotsRequest withSnapshotIds(Collection<String> 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.
- 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
public void setNextToken(String nextToken)
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
public String 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
public DescribeSnapshotsRequest withNextToken(String nextToken)
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
public void setLimit(Integer limit)
The maximum number of objects to return.
- Parameters:
limit
- The maximum number of objects to return.
-
getLimit
public Integer getLimit()
The maximum number of objects to return.
- Returns:
- The maximum number of objects to return.
-
withLimit
public DescribeSnapshotsRequest withLimit(Integer limit)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeSnapshotsRequest 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:
Object.clone()
-
-