com.amazonaws.services.ec2.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSnapshotsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSnapshotsRequest>, Serializable

public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeSnapshotsRequest>

Container for the parameters to the DescribeSnapshots operation.

Returns information about the Amazon EBS snapshots available to you. Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

See Also:

AmazonEC2.describeSnapshots(DescribeSnapshotsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeSnapshotsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for Snapshots.
List<String>	getOwnerIds() An optional list of owners by which to scope the described EBS snapshots.
List<String>	getRestorableByUserIds() An optional list of users.
List<String>	getSnapshotIds() The optional list of EBS snapshot IDs to describe.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for Snapshots.
void	setOwnerIds(Collection<String> ownerIds) An optional list of owners by which to scope the described EBS snapshots.
void	setRestorableByUserIds(Collection<String> restorableByUserIds) An optional list of users.
void	setSnapshotIds(Collection<String> snapshotIds) The optional list of EBS snapshot IDs to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSnapshotsRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for Snapshots.
DescribeSnapshotsRequest	withFilters(Filter... filters) A list of filters used to match properties for Snapshots.
DescribeSnapshotsRequest	withOwnerIds(Collection<String> ownerIds) An optional list of owners by which to scope the described EBS snapshots.
DescribeSnapshotsRequest	withOwnerIds(String... ownerIds) An optional list of owners by which to scope the described EBS snapshots.
DescribeSnapshotsRequest	withRestorableByUserIds(Collection<String> restorableByUserIds) An optional list of users.
DescribeSnapshotsRequest	withRestorableByUserIds(String... restorableByUserIds) An optional list of users.
DescribeSnapshotsRequest	withSnapshotIds(Collection<String> snapshotIds) The optional list of EBS snapshot IDs to describe.
DescribeSnapshotsRequest	withSnapshotIds(String... snapshotIds) The optional list of EBS snapshot IDs to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getSnapshotIds

public List<String> getSnapshotIds()

The optional list of EBS snapshot IDs to describe.

Returns:

The optional list of EBS snapshot IDs to describe.

setSnapshotIds

public void setSnapshotIds(Collection<String> snapshotIds)

The optional list of EBS snapshot IDs to describe.

Parameters:

snapshotIds - The optional list of EBS snapshot IDs to describe.

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds)

The optional list of EBS snapshot IDs to describe.

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

Parameters:

snapshotIds - The optional list of EBS snapshot IDs to describe.

Returns:

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

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(Collection<String> snapshotIds)

The optional list of EBS snapshot IDs to describe.

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

Parameters:

snapshotIds - The optional list of EBS snapshot IDs to describe.

Returns:

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

getOwnerIds

public List<String> getOwnerIds()

An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

Returns:

An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

setOwnerIds

public void setOwnerIds(Collection<String> ownerIds)

An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

Parameters:

ownerIds - An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(String... ownerIds)

An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

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

Parameters:

ownerIds - An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

Returns:

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

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(Collection<String> ownerIds)

An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

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

Parameters:

ownerIds - An optional list of owners by which to scope the described EBS snapshots. Valid values are:

• self : Snapshots owned by you
• AWS account ID : Snapshots owned by this account ID
• amazon : Snapshots owned by Amazon

The values self and amazon are literals.

Returns:

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

getRestorableByUserIds

public List<String> getRestorableByUserIds()

An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

Returns:

An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

setRestorableByUserIds

public void setRestorableByUserIds(Collection<String> restorableByUserIds)

An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

Parameters:

restorableByUserIds - An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(String... restorableByUserIds)

An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

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

Parameters:

restorableByUserIds - An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

Returns:

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

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(Collection<String> restorableByUserIds)

An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

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

Parameters:

restorableByUserIds - An optional list of users. The described snapshots are scoped to only those snapshots from which these users can create volumes.

Returns:

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

getFilters

public List<Filter> getFilters()

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(Collection<Filter> filters)

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

filters - A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeSnapshotsRequest withFilters(Filter... filters)

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

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

withFilters

public DescribeSnapshotsRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

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

getDryRunRequest

public Request<DescribeSnapshotsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeSnapshotsRequest>

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