com.amazonaws.services.ec2.model

Class DescribeSnapshotAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSnapshotAttributeRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeSnapshotAttributeRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeSnapshotAttributeRequest>

Container for the parameters to the DescribeSnapshotAttribute operation.

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.describeSnapshotAttribute(DescribeSnapshotAttributeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotAttributeRequest() Default constructor for a new DescribeSnapshotAttributeRequest object.
DescribeSnapshotAttributeRequest(java.lang.String snapshotId, SnapshotAttributeName attribute) Constructs a new DescribeSnapshotAttributeRequest object.
DescribeSnapshotAttributeRequest(java.lang.String snapshotId, java.lang.String attribute) Constructs a new DescribeSnapshotAttributeRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAttribute() The snapshot attribute you would like to view.
Request<DescribeSnapshotAttributeRequest>	getDryRunRequest() This method is intended for internal use only.
java.lang.String	getSnapshotId() The ID of the EBS snapshot.
int	hashCode()
void	setAttribute(SnapshotAttributeName attribute) The snapshot attribute you would like to view.
void	setAttribute(java.lang.String attribute) The snapshot attribute you would like to view.
void	setSnapshotId(java.lang.String snapshotId) The ID of the EBS snapshot.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSnapshotAttributeRequest	withAttribute(SnapshotAttributeName attribute) The snapshot attribute you would like to view.
DescribeSnapshotAttributeRequest	withAttribute(java.lang.String attribute) The snapshot attribute you would like to view.
DescribeSnapshotAttributeRequest	withSnapshotId(java.lang.String snapshotId) The ID of the EBS snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSnapshotAttributeRequest

public DescribeSnapshotAttributeRequest()

Default constructor for a new DescribeSnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeSnapshotAttributeRequest

public DescribeSnapshotAttributeRequest(java.lang.String snapshotId,
                                        java.lang.String attribute)

Constructs a new DescribeSnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

snapshotId - The ID of the EBS snapshot.

attribute - The snapshot attribute you would like to view.

DescribeSnapshotAttributeRequest

public DescribeSnapshotAttributeRequest(java.lang.String snapshotId,
                                        SnapshotAttributeName attribute)

Constructs a new DescribeSnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

snapshotId - The ID of the EBS snapshot.

attribute - The snapshot attribute you would like to view.

Method Detail

getSnapshotId

public java.lang.String getSnapshotId()

The ID of the EBS snapshot.

Returns:

The ID of the EBS snapshot.

setSnapshotId

public void setSnapshotId(java.lang.String snapshotId)

The ID of the EBS snapshot.

Parameters:

snapshotId - The ID of the EBS snapshot.

withSnapshotId

public DescribeSnapshotAttributeRequest withSnapshotId(java.lang.String snapshotId)

The ID of the EBS snapshot.

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

Parameters:

snapshotId - The ID of the EBS snapshot.

Returns:

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

getAttribute

public java.lang.String getAttribute()

The snapshot attribute you would like to view.

Constraints:
Allowed Values: productCodes, createVolumePermission

Returns:

The snapshot attribute you would like to view.

See Also:

SnapshotAttributeName

setAttribute

public void setAttribute(java.lang.String attribute)

The snapshot attribute you would like to view.

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The snapshot attribute you would like to view.

See Also:

SnapshotAttributeName

withAttribute

public DescribeSnapshotAttributeRequest withAttribute(java.lang.String attribute)

The snapshot attribute you would like to view.

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

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The snapshot attribute you would like to view.

Returns:

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

See Also:

SnapshotAttributeName

setAttribute

public void setAttribute(SnapshotAttributeName attribute)

The snapshot attribute you would like to view.

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The snapshot attribute you would like to view.

See Also:

SnapshotAttributeName

withAttribute

public DescribeSnapshotAttributeRequest withAttribute(SnapshotAttributeName attribute)

The snapshot attribute you would like to view.

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

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The snapshot attribute you would like to view.

Returns:

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

See Also:

SnapshotAttributeName

getDryRunRequest

public Request<DescribeSnapshotAttributeRequest> 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<DescribeSnapshotAttributeRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object