software.amazon.awssdk.services.glacier.model

Class DescribeJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.glacier.model.GlacierResponse

software.amazon.awssdk.services.glacier.model.DescribeJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>

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

Contains the description of an Amazon S3 Glacier job.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
ActionCode	action() The job type.
String	actionAsString() The job type.
String	archiveId() The archive ID requested for a select job or archive retrieval.
String	archiveSHA256TreeHash() The SHA256 tree hash of the entire archive for an archive retrieval.
Long	archiveSizeInBytes() For an archive retrieval job, this value is the size in bytes of the archive being requested for download.
static DescribeJobResponse.Builder	builder()
Boolean	completed() The job status.
String	completionDate() The UTC time that the job request completed.
String	creationDate() The UTC date when the job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
InventoryRetrievalJobDescription	inventoryRetrievalParameters() Parameters used for range inventory retrieval.
Long	inventorySizeInBytes() For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.
String	jobDescription() The job description provided when initiating the job.
String	jobId() An opaque string that identifies an Amazon S3 Glacier job.
String	jobOutputPath() Contains the job output location.
OutputLocation	outputLocation() Contains the location where the data from the select job is stored.
String	retrievalByteRange() The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
List<SdkField<?>>	sdkFields()
SelectParameters	selectParameters() Contains the parameters used for a select.
static Class<? extends DescribeJobResponse.Builder>	serializableBuilderClass()
String	sha256TreeHash() For an archive retrieval job, this value is the checksum of the archive.
String	snsTopic() An 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 tier to use for a select or an archive retrieval.
DescribeJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	vaultARN() The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Methods inherited from class software.amazon.awssdk.services.glacier.model.GlacierResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 S3 Glacier job.

Returns:

An opaque string that identifies an Amazon S3 Glacier job.

jobDescription

public String jobDescription()

The job description provided when initiating the job.

Returns:

The job description provided when initiating the job.

action

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

ActionCode

actionAsString

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

ActionCode

archiveId

public 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 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 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 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 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 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 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 String snsTopic()

An Amazon SNS topic that receives notification.

Returns:

An Amazon SNS topic that receives notification.

completionDate

public 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 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 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 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 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 InventoryRetrievalJobDescription inventoryRetrievalParameters()

Parameters used for range inventory retrieval.

Returns:

Parameters used for range inventory retrieval.

jobOutputPath

public String jobOutputPath()

Contains the job output location.

Returns:

Contains the job output location.

selectParameters

public SelectParameters selectParameters()

Contains the parameters used for a select.

Returns:

Contains the parameters used for a select.

outputLocation

public 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 DescribeJobResponse.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<DescribeJobResponse.Builder,DescribeJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

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