public static interface JobParameters.Builder extends CopyableBuilder<JobParameters.Builder,JobParameters>
Modifier and Type | Method and Description |
---|---|
JobParameters.Builder |
archiveId(String archiveId)
The ID of the archive that you want to retrieve.
|
JobParameters.Builder |
description(String description)
The optional description for the job.
|
JobParameters.Builder |
format(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.
|
default JobParameters.Builder |
inventoryRetrievalParameters(Consumer<InventoryRetrievalJobInput.Builder> inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
|
JobParameters.Builder |
inventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
|
JobParameters.Builder |
retrievalByteRange(String retrievalByteRange)
The byte range to retrieve for an archive retrieval.
|
JobParameters.Builder |
snsTopic(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.
|
JobParameters.Builder |
tier(String tier)
The retrieval option to use for the archive retrieval.
|
JobParameters.Builder |
type(String type)
The job type.
|
copy
apply, build
JobParameters.Builder format(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".
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".JobParameters.Builder type(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".
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".JobParameters.Builder archiveId(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.
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.JobParameters.Builder description(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.
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.JobParameters.Builder snsTopic(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.
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.JobParameters.Builder retrievalByteRange(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.
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.
JobParameters.Builder tier(String tier)
The retrieval option to use for the archive retrieval. Valid values are Expedited
,
Standard
, or Bulk
. Standard
is the default.
tier
- The retrieval option to use for the archive retrieval. Valid values are Expedited
,
Standard
, or Bulk
. Standard
is the default.JobParameters.Builder inventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
inventoryRetrievalParameters
- Input parameters used for range inventory retrieval.default JobParameters.Builder inventoryRetrievalParameters(Consumer<InventoryRetrievalJobInput.Builder> inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
This is a convenience that creates an instance of theInventoryRetrievalJobInput.Builder
avoiding the
need to create one manually via InventoryRetrievalJobInput.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to inventoryRetrievalParameters(InventoryRetrievalJobInput)
.inventoryRetrievalParameters
- a consumer that will call methods on InventoryRetrievalJobInput.Builder
inventoryRetrievalParameters(InventoryRetrievalJobInput)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.