software.amazon.awssdk.services.glacier.model

Class JobParameters

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<JobParameters.Builder,JobParameters>

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

Provides options for defining a job.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobParameters.Builder

Method Summary

Modifier and Type	Method and 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)
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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	retrievalByteRange() The byte range to retrieve for an archive retrieval.
static Class<? extends JobParameters.Builder>	serializableBuilderClass()
String	snsTopic() The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.
String	tier() The retrieval option to use for the archive retrieval.
JobParameters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type() The job type.

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

format

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

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

Returns:

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

archiveId

public String archiveId()

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. 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 archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

description

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

The Amazon SNS topic ARN to which Amazon 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 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 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 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 InventoryRetrievalJobInput inventoryRetrievalParameters()

Input parameters used for range inventory retrieval.

Returns:

Input parameters used for range inventory retrieval.

toBuilder

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

Returns:

a builder for type T

builder

public static JobParameters.Builder builder()

serializableBuilderClass

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