Class ExportToS3TaskSpecification

java.lang.Object
software.amazon.awssdk.services.ec2.model.ExportToS3TaskSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExportToS3TaskSpecification.Builder,ExportToS3TaskSpecification>
@Generated("software.amazon.awssdk:codegen") public final class ExportToS3TaskSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExportToS3TaskSpecification.Builder,ExportToS3TaskSpecification>

Describes an export instance task.

See Also:

  • Method Details

    • diskImageFormat

      public final DiskImageFormat diskImageFormat()

      The 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 format for the exported image.
      See Also:

    • diskImageFormatAsString

      public final String diskImageFormatAsString()

      The 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 format for the exported image.
      See Also:

    • containerFormat

      public final ContainerFormat containerFormat()

      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

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

      Returns:
      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
      See Also:

    • containerFormatAsString

      public final String containerFormatAsString()

      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

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

      Returns:
      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
      See Also:

    • s3Bucket

      public final String s3Bucket()

      The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

      Returns:
      The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

    • s3Prefix

      public final String s3Prefix()

      The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

      Returns:
      The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

    • toBuilder

      public ExportToS3TaskSpecification.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<ExportToS3TaskSpecification.Builder,ExportToS3TaskSpecification>
      Returns:
      a builder for type T

    • builder

      public static ExportToS3TaskSpecification.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.