com.amazonaws.services.ec2.model

Class DescribeSnapshotAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSnapshotAttributeRequest>, Serializable

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

Container for the parameters to the DescribeSnapshotAttribute operation.

Returns information about an attribute of a snapshot. Only one attribute can be specified per call.

See Also:

AmazonEC2.describeSnapshotAttribute(DescribeSnapshotAttributeRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

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

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

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(String snapshotId,
                                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 whose attribute is being described.

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

DescribeSnapshotAttributeRequest

public DescribeSnapshotAttributeRequest(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 whose attribute is being described.

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

Method Detail

getSnapshotId

public String getSnapshotId()

The ID of the EBS snapshot whose attribute is being described.

Returns:

The ID of the EBS snapshot whose attribute is being described.

setSnapshotId

public void setSnapshotId(String snapshotId)

The ID of the EBS snapshot whose attribute is being described.

Parameters:

snapshotId - The ID of the EBS snapshot whose attribute is being described.

withSnapshotId

public DescribeSnapshotAttributeRequest withSnapshotId(String snapshotId)

The ID of the EBS snapshot whose attribute is being described.

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

Parameters:

snapshotId - The ID of the EBS snapshot whose attribute is being described.

Returns:

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

getAttribute

public String getAttribute()

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Returns:

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

setAttribute

public void setAttribute(String attribute)

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

withAttribute

public DescribeSnapshotAttributeRequest withAttribute(String attribute)

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

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

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

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 name of the EBS attribute to describe.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

withAttribute

public DescribeSnapshotAttributeRequest withAttribute(SnapshotAttributeName attribute)

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

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

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

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 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