Class GlacierJobDescription

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

Contains the description of an Amazon S3 Glacier job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      An opaque string that identifies an Amazon S3 Glacier job.

      Returns:
      An opaque string that identifies an Amazon S3 Glacier job.

    • jobDescription

      public final String jobDescription()

      The job description provided when initiating the job.

      Returns:
      The job description provided when initiating the job.

    • action

      public final ActionCode action()

      The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

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

      Returns:
      The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
      See Also:

    • actionAsString

      public final String actionAsString()

      The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

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

      Returns:
      The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
      See Also:

    • archiveId

      public final String archiveId()

      The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

      Returns:
      The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

    • vaultARN

      public final String vaultARN()

      The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

      Returns:
      The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

    • creationDate

      public final String creationDate()

      The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

      Returns:
      The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

    • completed

      public final Boolean completed()

      The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

      Returns:
      The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

    • statusCode

      public final StatusCode statusCode()

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

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

      Returns:
      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

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

      Returns:
      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      See Also:

    • statusMessage

      public final String statusMessage()

      A friendly message that describes the job status.

      Returns:
      A friendly message that describes the job status.

    • archiveSizeInBytes

      public final Long archiveSizeInBytes()

      For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

      Returns:
      For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

    • inventorySizeInBytes

      public final Long inventorySizeInBytes()

      For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

      Returns:
      For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

    • snsTopic

      public final String snsTopic()

      An Amazon SNS topic that receives notification.

      Returns:
      An Amazon SNS topic that receives notification.

    • completionDate

      public final String completionDate()

      The UTC time that the job request completed. While the job is in progress, the value is null.

      Returns:
      The UTC time that the job request completed. While the job is in progress, the value is null.

    • sha256TreeHash

      public final String sha256TreeHash()

      For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

      The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

      If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

      This field is null for the following:

      • Archive retrieval jobs that specify a range that is not tree-hash aligned

      • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

      • Inventory jobs

      • Select jobs

      Returns:
      For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

      The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

      If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

      This field is null for the following:

      • Archive retrieval jobs that specify a range that is not tree-hash aligned

      • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

      • Inventory jobs

      • Select jobs

    • archiveSHA256TreeHash

      public final String archiveSHA256TreeHash()

      The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

      Returns:
      The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

    • retrievalByteRange

      public final String retrievalByteRange()

      The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

      Returns:
      The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

    • tier

      public final String tier()

      The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

      Returns:
      The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

    • inventoryRetrievalParameters

      public final InventoryRetrievalJobDescription inventoryRetrievalParameters()

      Parameters used for range inventory retrieval.

      Returns:
      Parameters used for range inventory retrieval.

    • jobOutputPath

      public final String jobOutputPath()

      Contains the job output location.

      Returns:
      Contains the job output location.

    • selectParameters

      public final SelectParameters selectParameters()

      Contains the parameters used for a select.

      Returns:
      Contains the parameters used for a select.

    • outputLocation

      public final OutputLocation outputLocation()

      Contains the location where the data from the select job is stored.

      Returns:
      Contains the location where the data from the select job is stored.

    • toBuilder

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

    • builder

      public static GlacierJobDescription.Builder builder()

    • serializableBuilderClass

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