com.amazonaws.services.directory.model

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

Container for the parameters to the DescribeSnapshots operation.

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

See Also:

AWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeSnapshotsRequest	clone()
boolean	equals(Object obj)
String	getDirectoryId() The identifier of the directory to retrieve snapshot information for.
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 to retrieve snapshot information for.
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 to retrieve snapshot information for.
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(Collection<String> snapshotIds) A list of identifiers of the snapshots to obtain the information for.
DescribeSnapshotsRequest	withSnapshotIds(String... snapshotIds) A list of identifiers of the snapshots to obtain the information for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getDirectoryId

public String getDirectoryId()

The identifier of the directory to retrieve snapshot information for.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Returns:

The identifier of the directory to retrieve snapshot information for.

setDirectoryId

public void setDirectoryId(String directoryId)

The identifier of the directory to retrieve snapshot information for.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Parameters:

directoryId - The identifier of the directory to retrieve snapshot information for.

withDirectoryId

public DescribeSnapshotsRequest withDirectoryId(String directoryId)

The identifier of the directory to retrieve snapshot information for.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Parameters:

directoryId - The identifier of the directory to retrieve snapshot information for.

Returns:

A reference to this updated 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) or withSnapshotIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

withNextToken

public DescribeSnapshotsRequest withNextToken(String nextToken)

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of objects to return.

Constraints:
Range: 0 -

Returns:

The maximum number of objects to return.

setLimit

public void setLimit(Integer limit)

The maximum number of objects to return.

Constraints:
Range: 0 -

Parameters:

limit - The maximum number of objects to return.

withLimit

public DescribeSnapshotsRequest withLimit(Integer limit)

The maximum number of objects to return.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

limit - The maximum number of objects to return.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeSnapshotsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest