software.amazon.awssdk.services.glacier.model

Class GlacierJobDescription

java.lang.Object

software.amazon.awssdk.services.glacier.model.GlacierJobDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<GlacierJobDescription.Builder,GlacierJobDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class GlacierJobDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<GlacierJobDescription.Builder,GlacierJobDescription>

Describes an Amazon Glacier job.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlacierJobDescription.Builder

Method Summary

Modifier and Type	Method and Description
ActionCode	action() The job type.
String	actionAsString() The job type.
String	archiveId() For an ArchiveRetrieval job, this is the archive ID requested for download.
String	archiveSHA256TreeHash() The SHA256 tree hash of the entire archive for an archive retrieval.
Long	archiveSizeInBytes() For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
static GlacierJobDescription.Builder	builder()
Boolean	completed() The job status.
String	completionDate() The UTC time that the archive retrieval request completed.
String	creationDate() The UTC date when the job was created.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InventoryRetrievalJobDescription	inventoryRetrievalParameters() Parameters used for range inventory retrieval.
Long	inventorySizeInBytes() For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
String	jobDescription() The job description you provided when you initiated the job.
String	jobId() An opaque string that identifies an Amazon Glacier job.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1.
static Class<? extends GlacierJobDescription.Builder>	serializableBuilderClass()
String	sha256TreeHash() For an ArchiveRetrieval job, it is the checksum of the archive.
String	snsTopic() An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
StatusCode	statusCode() The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
String	statusCodeAsString() The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
String	statusMessage() A friendly message that describes the job status.
String	tier() The retrieval option to use for the archive retrieval.
GlacierJobDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vaultARN() The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobId

public String jobId()

An opaque string that identifies an Amazon Glacier job.

Returns:

An opaque string that identifies an Amazon Glacier job.

jobDescription

public String jobDescription()

The job description you provided when you initiated the job.

Returns:

The job description you provided when you initiated the job.

action

public ActionCode action()

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

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. It is either ArchiveRetrieval or InventoryRetrieval.

See Also:

ActionCode

actionAsString

public String actionAsString()

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

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. It is either ArchiveRetrieval or InventoryRetrieval.

See Also:

ActionCode

archiveId

public String archiveId()

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

Returns:

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

vaultARN

public String vaultARN()

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

Returns:

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

creationDate

public String creationDate()

The UTC date when the job was created. 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. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

completed

public Boolean completed()

The job status. When a job is completed, you get the job's output.

Returns:

The job status. When a job is completed, you get the job's output.

statusCode

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

StatusCode

statusCodeAsString

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

StatusCode

statusMessage

public String statusMessage()

A friendly message that describes the job status.

Returns:

A friendly message that describes the job status.

archiveSizeInBytes

public Long archiveSizeInBytes()

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

Returns:

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

inventorySizeInBytes

public Long inventorySizeInBytes()

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

Returns:

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

snsTopic

public String snsTopic()

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

Returns:

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

completionDate

public String completionDate()

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

Returns:

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

sha256TreeHash

public String sha256TreeHash()

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

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

For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null in the following situations:

• 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 and the job status is InProgress.

• Inventory jobs.

Returns:

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

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

For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null in the following situations:

• 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 and the job status is InProgress.

• Inventory jobs.

archiveSHA256TreeHash

public String archiveSHA256TreeHash()

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

Returns:

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

retrievalByteRange

public 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

tier

public String tier()

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Returns:

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

inventoryRetrievalParameters

public InventoryRetrievalJobDescription inventoryRetrievalParameters()

Parameters used for range inventory retrieval.

Returns:

Parameters used for range inventory retrieval.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.