com.amazonaws.services.ec2.model

Class DescribeImageAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeImageAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeImageAttributeRequest>, Serializable

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

Container for the parameters to the DescribeImageAttribute operation.

The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.

See Also:

AmazonEC2.describeImageAttribute(DescribeImageAttributeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeImageAttributeRequest() Default constructor for a new DescribeImageAttributeRequest object.
DescribeImageAttributeRequest(String imageId, ImageAttributeName attribute) Constructs a new DescribeImageAttributeRequest object.
DescribeImageAttributeRequest(String imageId, String attribute) Constructs a new DescribeImageAttributeRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttribute() The name of the attribute to describe.
Request<DescribeImageAttributeRequest>	getDryRunRequest() This method is intended for internal use only.
String	getImageId() The ID of the AMI whose attribute is to be described.
int	hashCode()
void	setAttribute(ImageAttributeName attribute) The name of the attribute to describe.
void	setAttribute(String attribute) The name of the attribute to describe.
void	setImageId(String imageId) The ID of the AMI whose attribute is to be described.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeImageAttributeRequest	withAttribute(ImageAttributeName attribute) The name of the attribute to describe.
DescribeImageAttributeRequest	withAttribute(String attribute) The name of the attribute to describe.
DescribeImageAttributeRequest	withImageId(String imageId) The ID of the AMI whose attribute is to be 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

DescribeImageAttributeRequest

public DescribeImageAttributeRequest()

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

DescribeImageAttributeRequest

public DescribeImageAttributeRequest(String imageId,
                             String attribute)

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

Parameters:

imageId - The ID of the AMI whose attribute is to be described.

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

DescribeImageAttributeRequest

public DescribeImageAttributeRequest(String imageId,
                             ImageAttributeName attribute)

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

Parameters:

imageId - The ID of the AMI whose attribute is to be described.

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Method Detail

getImageId

public String getImageId()

The ID of the AMI whose attribute is to be described.

Returns:

The ID of the AMI whose attribute is to be described.

setImageId

public void setImageId(String imageId)

The ID of the AMI whose attribute is to be described.

Parameters:

imageId - The ID of the AMI whose attribute is to be described.

withImageId

public DescribeImageAttributeRequest withImageId(String imageId)

The ID of the AMI whose attribute is to be described.

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

Parameters:

imageId - The ID of the AMI whose attribute is to be described.

Returns:

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

getAttribute

public String getAttribute()

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping

Returns:

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

See Also:

ImageAttributeName

setAttribute

public void setAttribute(String attribute)

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping

Parameters:

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

See Also:

ImageAttributeName

withAttribute

public DescribeImageAttributeRequest withAttribute(String attribute)

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

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

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping

Parameters:

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Returns:

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

See Also:

ImageAttributeName

setAttribute

public void setAttribute(ImageAttributeName attribute)

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping

Parameters:

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

See Also:

ImageAttributeName

withAttribute

public DescribeImageAttributeRequest withAttribute(ImageAttributeName attribute)

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

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

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping

Parameters:

attribute - The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Returns:

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

See Also:

ImageAttributeName

getDryRunRequest

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

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