Class ExportImageTask

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

Information about an export image task, including its current state, timestamps, and any error details.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.

      Returns:
      The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.

    • imageArn

      public final String imageArn()

      The ARN of the WorkSpaces Applications image being exported.

      Returns:
      The ARN of the WorkSpaces Applications image being exported.

    • amiName

      public final String amiName()

      The name of the EC2 AMI that will be created by this export task.

      Returns:
      The name of the EC2 AMI that will be created by this export task.

    • createdDate

      public final Instant createdDate()

      The date and time when the export image task was created.

      Returns:
      The date and time when the export image task was created.

    • amiDescription

      public final String amiDescription()

      The description that will be applied to the exported EC2 AMI.

      Returns:
      The description that will be applied to the exported EC2 AMI.

    • state

      public final ExportImageTaskState state()

      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

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

      Returns:
      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

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

      Returns:
      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
      See Also:

    • amiId

      public final String amiId()

      The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

      Returns:
      The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications 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.

    • tagSpecifications

      public final Map<String,String> tagSpecifications()

      The tags that will be applied to the exported EC2 AMI.

      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 hasTagSpecifications() method.

      Returns:
      The tags that will be applied to the exported EC2 AMI.

    • hasErrorDetails

      public final boolean hasErrorDetails()
      For responses, this returns true if the service returned a value for the ErrorDetails 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.

    • errorDetails

      public final List<ErrorDetails> errorDetails()

      Details about any errors that occurred during the export process. This field is only populated when the task fails.

      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 hasErrorDetails() method.

      Returns:
      Details about any errors that occurred during the export process. This field is only populated when the task fails.

    • toBuilder

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

    • builder

      public static ExportImageTask.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportImageTask.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.