Package software.amazon.awssdk.services.glacier.model

Class JobParameters

java.lang.Object

software.amazon.awssdk.services.glacier.model.JobParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobParameters.Builder,JobParameters>

@Generated("software.amazon.awssdk:codegen")
public final class JobParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobParameters.Builder,JobParameters>

Provides options for defining a job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobParameters.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveId()	The ID of the archive that you want to retrieve.
static JobParameters.Builder	builder()
String	description()	The optional description for the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	format()	When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InventoryRetrievalJobInput	inventoryRetrievalParameters()	Input parameters used for range inventory retrieval.
OutputLocation	outputLocation()	Contains information about the location where the select job results are stored.
String	retrievalByteRange()	The byte range to retrieve for an archive retrieval.
List<SdkField<?>>	sdkFields()
SelectParameters	selectParameters()	Contains the parameters that define a job.
static Class<? extends JobParameters.Builder>	serializableBuilderClass()
String	snsTopic()	The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download.
String	tier()	The tier to use for a select or an archive retrieval job.
JobParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The job type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

format

public final String format()

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Returns:

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

type

public final String type()

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Returns:

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

archiveId

public final String archiveId()

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Returns:

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

description

public final String description()

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Returns:

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

snsTopic

public final String snsTopic()

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Returns:

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

retrievalByteRange

public final String retrievalByteRange()

The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Returns:

The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

tier

public final String tier()

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

Returns:

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

inventoryRetrievalParameters

public final InventoryRetrievalJobInput inventoryRetrievalParameters()

Input parameters used for range inventory retrieval.

Returns:

Input parameters used for range inventory retrieval.

selectParameters

public final SelectParameters selectParameters()

Contains the parameters that define a job.

Returns:

Contains the parameters that define a job.

outputLocation

public final OutputLocation outputLocation()

Contains information about the location where the select job results are stored.

Returns:

Contains information about the location where the select job results are stored.

toBuilder

public JobParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobParameters.Builder,JobParameters>

builder

public static JobParameters.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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