com.amazonaws.services.glacier.model

Class UploadMultipartPartRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.UploadMultipartPartRequest

All Implemented Interfaces:

Serializable

public class UploadMultipartPartRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UploadMultipartPart operation.

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

• SHA256 tree hash does not match To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums .

• Part size does not match The size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

  NOTE: If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.

• Range does not align The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.uploadMultipartPart(UploadMultipartPartRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UploadMultipartPartRequest() Default constructor for a new UploadMultipartPartRequest object.
UploadMultipartPartRequest(String vaultName, String uploadId, String checksum, String range, InputStream body) Constructs a new UploadMultipartPartRequest object.
UploadMultipartPartRequest(String accountId, String vaultName, String uploadId, String checksum, String range, InputStream body) Constructs a new UploadMultipartPartRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccountId() The AccountId is the AWS Account ID.
InputStream	getBody() The data to upload.
String	getChecksum() The SHA256 tree hash of the data being uploaded.
String	getRange() Identifies the range of bytes in the assembled archive that will be uploaded in this part.
String	getUploadId() The upload ID of the multipart upload.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId is the AWS Account ID.
void	setBody(InputStream body) The data to upload.
void	setChecksum(String checksum) The SHA256 tree hash of the data being uploaded.
void	setRange(String range) Identifies the range of bytes in the assembled archive that will be uploaded in this part.
void	setUploadId(String uploadId) The upload ID of the multipart upload.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UploadMultipartPartRequest	withAccountId(String accountId) The AccountId is the AWS Account ID.
UploadMultipartPartRequest	withBody(InputStream body) The data to upload.
UploadMultipartPartRequest	withChecksum(String checksum) The SHA256 tree hash of the data being uploaded.
UploadMultipartPartRequest	withRange(String range) Identifies the range of bytes in the assembled archive that will be uploaded in this part.
UploadMultipartPartRequest	withUploadId(String uploadId) The upload ID of the multipart upload.
UploadMultipartPartRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadMultipartPartRequest

public UploadMultipartPartRequest()

Default constructor for a new UploadMultipartPartRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

UploadMultipartPartRequest

public UploadMultipartPartRequest(String vaultName,
                          String uploadId,
                          String checksum,
                          String range,
                          InputStream body)

Constructs a new UploadMultipartPartRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

vaultName - The name of the vault.

uploadId - The upload ID of the multipart upload.

checksum - The SHA256 tree hash of the data being uploaded.

range - Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

body - The data to upload.

UploadMultipartPartRequest

public UploadMultipartPartRequest(String accountId,
                          String vaultName,
                          String uploadId,
                          String checksum,
                          String range,
                          InputStream body)

Constructs a new UploadMultipartPartRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName - The name of the vault.

uploadId - The upload ID of the multipart upload.

checksum - The SHA256 tree hash of the data being uploaded.

range - Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

body - The data to upload.

Method Detail

getAccountId

public String getAccountId()

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Returns:

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

setAccountId

public void setAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

withAccountId

public UploadMultipartPartRequest withAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

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

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Returns:

A reference to this updated object so that method calls can be chained together.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

withVaultName

public UploadMultipartPartRequest withVaultName(String vaultName)

The name of the vault.

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

Parameters:

vaultName - The name of the vault.

Returns:

A reference to this updated object so that method calls can be chained together.

getUploadId

public String getUploadId()

The upload ID of the multipart upload.

Returns:

The upload ID of the multipart upload.

setUploadId

public void setUploadId(String uploadId)

The upload ID of the multipart upload.

Parameters:

uploadId - The upload ID of the multipart upload.

withUploadId

public UploadMultipartPartRequest withUploadId(String uploadId)

The upload ID of the multipart upload.

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

Parameters:

uploadId - The upload ID of the multipart upload.

Returns:

A reference to this updated object so that method calls can be chained together.

getChecksum

public String getChecksum()

The SHA256 tree hash of the data being uploaded.

Returns:

The SHA256 tree hash of the data being uploaded.

setChecksum

public void setChecksum(String checksum)

The SHA256 tree hash of the data being uploaded.

Parameters:

checksum - The SHA256 tree hash of the data being uploaded.

withChecksum

public UploadMultipartPartRequest withChecksum(String checksum)

The SHA256 tree hash of the data being uploaded.

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

Parameters:

checksum - The SHA256 tree hash of the data being uploaded.

Returns:

A reference to this updated object so that method calls can be chained together.

getRange

public String getRange()

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

Returns:

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

setRange

public void setRange(String range)

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

Parameters:

range - Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

withRange

public UploadMultipartPartRequest withRange(String range)

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

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

Parameters:

range - Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

Returns:

A reference to this updated object so that method calls can be chained together.

getBody

public InputStream getBody()

The data to upload. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Returns:

The data to upload.

setBody

public void setBody(InputStream body)

The data to upload. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Parameters:

body - The data to upload.

withBody

public UploadMultipartPartRequest withBody(InputStream body)

The data to upload. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

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

Parameters:

body - The data to upload.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object