software.amazon.awssdk.services.glacier.model

Interface GlacierJobDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GlacierJobDescription.Builder,GlacierJobDescription>, SdkBuilder<GlacierJobDescription.Builder,GlacierJobDescription>, SdkPojo

Enclosing class:

GlacierJobDescription

public static interface GlacierJobDescription.Builder
extends SdkPojo, CopyableBuilder<GlacierJobDescription.Builder,GlacierJobDescription>

Method Summary

Modifier and Type	Method and Description
GlacierJobDescription.Builder	action(ActionCode action) The job type.
GlacierJobDescription.Builder	action(String action) The job type.
GlacierJobDescription.Builder	archiveId(String archiveId) The archive ID requested for a select job or archive retrieval.
GlacierJobDescription.Builder	archiveSHA256TreeHash(String archiveSHA256TreeHash) The SHA256 tree hash of the entire archive for an archive retrieval.
GlacierJobDescription.Builder	archiveSizeInBytes(Long archiveSizeInBytes) For an archive retrieval job, this value is the size in bytes of the archive being requested for download.
GlacierJobDescription.Builder	completed(Boolean completed) The job status.
GlacierJobDescription.Builder	completionDate(String completionDate) The UTC time that the job request completed.
GlacierJobDescription.Builder	creationDate(String creationDate) The UTC date when the job was created.
default GlacierJobDescription.Builder	inventoryRetrievalParameters(Consumer<InventoryRetrievalJobDescription.Builder> inventoryRetrievalParameters) Parameters used for range inventory retrieval.
GlacierJobDescription.Builder	inventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.
GlacierJobDescription.Builder	inventorySizeInBytes(Long inventorySizeInBytes) For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.
GlacierJobDescription.Builder	jobDescription(String jobDescription) The job description provided when initiating the job.
GlacierJobDescription.Builder	jobId(String jobId) An opaque string that identifies an Amazon Glacier job.
GlacierJobDescription.Builder	jobOutputPath(String jobOutputPath) Contains the job output location.
default GlacierJobDescription.Builder	outputLocation(Consumer<OutputLocation.Builder> outputLocation) Contains the location where the data from the select job is stored.
GlacierJobDescription.Builder	outputLocation(OutputLocation outputLocation) Contains the location where the data from the select job is stored.
GlacierJobDescription.Builder	retrievalByteRange(String retrievalByteRange) The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
default GlacierJobDescription.Builder	selectParameters(Consumer<SelectParameters.Builder> selectParameters) Contains the parameters used for a select.
GlacierJobDescription.Builder	selectParameters(SelectParameters selectParameters) Contains the parameters used for a select.
GlacierJobDescription.Builder	sha256TreeHash(String sha256TreeHash) For an archive retrieval job, this value is the checksum of the archive.
GlacierJobDescription.Builder	snsTopic(String snsTopic) An Amazon SNS topic that receives notification.
GlacierJobDescription.Builder	statusCode(StatusCode statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
GlacierJobDescription.Builder	statusCode(String statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
GlacierJobDescription.Builder	statusMessage(String statusMessage) A friendly message that describes the job status.
GlacierJobDescription.Builder	tier(String tier) The tier to use for a select or an archive retrieval.
GlacierJobDescription.Builder	vaultARN(String vaultARN) The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

GlacierJobDescription.Builder jobId(String jobId)

An opaque string that identifies an Amazon Glacier job.

Parameters:

jobId - An opaque string that identifies an Amazon Glacier job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobDescription

GlacierJobDescription.Builder jobDescription(String jobDescription)

The job description provided when initiating the job.

Parameters:

jobDescription - The job description provided when initiating the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

action

GlacierJobDescription.Builder action(String action)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionCode, ActionCode

action

GlacierJobDescription.Builder action(ActionCode action)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionCode, ActionCode

archiveId

GlacierJobDescription.Builder archiveId(String archiveId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

vaultARN

GlacierJobDescription.Builder vaultARN(String vaultARN)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

creationDate

GlacierJobDescription.Builder creationDate(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".

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

completed

GlacierJobDescription.Builder completed(Boolean completed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

statusCode

GlacierJobDescription.Builder statusCode(String statusCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatusCode, StatusCode

statusCode

GlacierJobDescription.Builder statusCode(StatusCode statusCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatusCode, StatusCode

statusMessage

GlacierJobDescription.Builder statusMessage(String statusMessage)

A friendly message that describes the job status.

Parameters:

statusMessage - A friendly message that describes the job status.

Returns:

Returns a reference to this object so that method calls can be chained together.

archiveSizeInBytes

GlacierJobDescription.Builder archiveSizeInBytes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

inventorySizeInBytes

GlacierJobDescription.Builder inventorySizeInBytes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

snsTopic

GlacierJobDescription.Builder snsTopic(String snsTopic)

An Amazon SNS topic that receives notification.

Parameters:

snsTopic - An Amazon SNS topic that receives notification.

Returns:

Returns a reference to this object so that method calls can be chained together.

completionDate

GlacierJobDescription.Builder completionDate(String completionDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sha256TreeHash

GlacierJobDescription.Builder sha256TreeHash(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

archiveSHA256TreeHash

GlacierJobDescription.Builder archiveSHA256TreeHash(String archiveSHA256TreeHash)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

retrievalByteRange

GlacierJobDescription.Builder retrievalByteRange(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tier

GlacierJobDescription.Builder tier(String tier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

inventoryRetrievalParameters

GlacierJobDescription.Builder inventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)

Parameters used for range inventory retrieval.

Parameters:

inventoryRetrievalParameters - Parameters used for range inventory retrieval.

Returns:

Returns a reference to this object so that method calls can be chained together.

inventoryRetrievalParameters

default GlacierJobDescription.Builder inventoryRetrievalParameters(Consumer<InventoryRetrievalJobDescription.Builder> inventoryRetrievalParameters)

Parameters used for range inventory retrieval.

This is a convenience that creates an instance of the InventoryRetrievalJobDescription.Builder avoiding the need to create one manually via InventoryRetrievalJobDescription.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inventoryRetrievalParameters(InventoryRetrievalJobDescription).

Parameters:

inventoryRetrievalParameters - a consumer that will call methods on InventoryRetrievalJobDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

inventoryRetrievalParameters(InventoryRetrievalJobDescription)

jobOutputPath

GlacierJobDescription.Builder jobOutputPath(String jobOutputPath)

Contains the job output location.

Parameters:

jobOutputPath - Contains the job output location.

Returns:

Returns a reference to this object so that method calls can be chained together.

selectParameters

GlacierJobDescription.Builder selectParameters(SelectParameters selectParameters)

Contains the parameters used for a select.

Parameters:

selectParameters - Contains the parameters used for a select.

Returns:

Returns a reference to this object so that method calls can be chained together.

selectParameters

default GlacierJobDescription.Builder selectParameters(Consumer<SelectParameters.Builder> selectParameters)

Contains the parameters used for a select.

This is a convenience that creates an instance of the SelectParameters.Builder avoiding the need to create one manually via SelectParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selectParameters(SelectParameters).

Parameters:

selectParameters - a consumer that will call methods on SelectParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

selectParameters(SelectParameters)

outputLocation

GlacierJobDescription.Builder outputLocation(OutputLocation outputLocation)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

outputLocation

default GlacierJobDescription.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation)

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

This is a convenience that creates an instance of the OutputLocation.Builder avoiding the need to create one manually via OutputLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputLocation(OutputLocation).

Parameters:

outputLocation - a consumer that will call methods on OutputLocation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

outputLocation(OutputLocation)