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>

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExportImageResponse.Builder,ExportImageResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.