software.amazon.awssdk.services.ec2.model

Class ExportImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.ExportImageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExportImageRequest
extends Ec2Request
implements ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportImageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ExportImageRequest.Builder	builder()
String	clientToken() Token to enable idempotency for export image requests.
String	description() A description of the image being exported.
DiskImageFormat	diskImageFormat() The disk image format.
String	diskImageFormatAsString() The disk image format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	imageId() The ID of the image.
String	roleName() The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
ExportTaskS3LocationRequest	s3ExportLocation() Information about the destination Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends ExportImageRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications() The tags to apply to the image being exported.
ExportImageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public String clientToken()

Token to enable idempotency for export image requests.

Returns:

Token to enable idempotency for export image requests.

description

public String description()

A description of the image being exported. The maximum length is 255 characters.

Returns:

A description of the image being exported. The maximum length is 255 characters.

diskImageFormat

public DiskImageFormat diskImageFormat()

The disk image format.

If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().

Returns:

The disk image format.

See Also:

DiskImageFormat

diskImageFormatAsString

public String diskImageFormatAsString()

The disk image format.

If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().

Returns:

The disk image format.

See Also:

DiskImageFormat

imageId

public String imageId()

The ID of the image.

Returns:

The ID of the image.

s3ExportLocation

public ExportTaskS3LocationRequest s3ExportLocation()

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].

Returns:

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].

roleName

public String roleName()

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Returns:

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

hasTagSpecifications

public boolean hasTagSpecifications()

Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tagSpecifications

public List<TagSpecification> tagSpecifications()

The tags to apply to the image being exported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTagSpecifications() to see if a value was sent in this field.

Returns:

The tags to apply to the image being exported.

toBuilder

public ExportImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ExportImageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ExportImageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo