Package software.amazon.awssdk.services.ec2.model

Class ExportImageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ec2.model.Ec2Response

software.amazon.awssdk.services.ec2.model.ExportImageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExportImageResponse.Builder,ExportImageResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ExportImageResponse
extends Ec2Response
implements ToCopyableBuilder<ExportImageResponse.Builder,ExportImageResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExportImageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ExportImageResponse.Builder	builder()
String	description()	A description of the image being exported.
DiskImageFormat	diskImageFormat()	The disk image format for the exported image.
String	diskImageFormatAsString()	The disk image format for the exported image.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exportImageTaskId()	The ID of the export image task.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	imageId()	The ID of the image.
String	progress()	The percent complete of the export image task.
String	roleName()	The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
ExportTaskS3Location	s3ExportLocation()	Information about the destination Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends ExportImageResponse.Builder>	serializableBuilderClass()
String	status()	The status of the export image task.
String	statusMessage()	The status message for the export image task.
List<Tag>	tags()	Any tags assigned to the export image task.
ExportImageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ec2.model.Ec2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

description

public final String description()

A description of the image being exported.

Returns:

A description of the image being exported.

diskImageFormat

public final DiskImageFormat diskImageFormat()

The disk image format for the exported image.

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 for the exported image.

See Also:

DiskImageFormat

diskImageFormatAsString

public final String diskImageFormatAsString()

The disk image format for the exported image.

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 for the exported image.

See Also:

DiskImageFormat

exportImageTaskId

public final String exportImageTaskId()

The ID of the export image task.

Returns:

The ID of the export image task.

imageId

public final String imageId()

The ID of the image.

Returns:

The ID of the image.

roleName

public final String roleName()

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.

Returns:

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.

progress

public final String progress()

The percent complete of the export image task.

Returns:

The percent complete of the export image task.

s3ExportLocation

public final ExportTaskS3Location s3ExportLocation()

Information about the destination Amazon S3 bucket.

Returns:

Information about the destination Amazon S3 bucket.

status

public final String status()

The status of the export image task. The possible values are active, completed, deleting, and deleted.

Returns:

The status of the export image task. The possible values are active, completed, deleting, and deleted.

statusMessage

public final String statusMessage()

The status message for the export image task.

Returns:

The status message for the export image task.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Any tags assigned to the export image task.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Any tags assigned to the export image task.

toBuilder

public ExportImageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportImageResponse.Builder,ExportImageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ExportImageResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo