public static interface GetJobOutputRequest.Builder extends GlacierRequest.Builder, SdkPojo, CopyableBuilder<GetJobOutputRequest.Builder,GetJobOutputRequest>
Modifier and Type | Method and Description |
---|---|
GetJobOutputRequest.Builder |
accountId(String accountId)
The
AccountId value is the AWS account ID of the account that owns the vault. |
GetJobOutputRequest.Builder |
jobId(String jobId)
The job ID whose data is downloaded.
|
GetJobOutputRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
GetJobOutputRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
GetJobOutputRequest.Builder |
range(String range)
The range of bytes to retrieve from the output.
|
GetJobOutputRequest.Builder |
vaultName(String vaultName)
The name of the vault.
|
build
overrideConfiguration
copy
applyMutation, build
GetJobOutputRequest.Builder accountId(String accountId)
The AccountId
value is the AWS account ID of the account that owns the vault. You can either
specify an AWS account ID or optionally a single '-
' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not
include any hyphens ('-') in the ID.
accountId
- The AccountId
value is the AWS account ID of the account that owns the vault. You can
either specify an AWS account ID or optionally a single '-
' (hyphen), in which case
Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If
you use an account ID, do not include any hyphens ('-') in the ID.GetJobOutputRequest.Builder vaultName(String vaultName)
The name of the vault.
vaultName
- The name of the vault.GetJobOutputRequest.Builder jobId(String jobId)
The job ID whose data is downloaded.
jobId
- The job ID whose data is downloaded.GetJobOutputRequest.Builder range(String range)
The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576
bytes, specify the range as bytes=0-1048575
. By default, this operation downloads the entire
output.
If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
range
- The range of bytes to retrieve from the output. For example, if you want to download the first
1,048,576 bytes, specify the range as bytes=0-1048575
. By default, this operation
downloads the entire output.
If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
GetJobOutputRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.GetJobOutputRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.