com.amazonaws.services.glacier.model

Class CompleteMultipartUploadRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.CompleteMultipartUploadRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CompleteMultipartUploadRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CompleteMultipartUpload operation.

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums . On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

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 Complete Multipart Upload in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.completeMultipartUpload(CompleteMultipartUploadRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CompleteMultipartUploadRequest() Default constructor for a new CompleteMultipartUploadRequest object.
CompleteMultipartUploadRequest(String vaultName, String uploadId, String archiveSize, String checksum) Constructs a new CompleteMultipartUploadRequest object.
CompleteMultipartUploadRequest(String accountId, String vaultName, String uploadId, String archiveSize, String checksum) Constructs a new CompleteMultipartUploadRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
CompleteMultipartUploadRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID of the account that owns the vault.
String	getArchiveSize() The total size, in bytes, of the entire archive.
String	getChecksum() The SHA256 tree hash of the entire archive.
String	getUploadId() The upload ID of the multipart upload.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
void	setArchiveSize(String archiveSize) The total size, in bytes, of the entire archive.
void	setChecksum(String checksum) The SHA256 tree hash of the entire archive.
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.
CompleteMultipartUploadRequest	withAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
CompleteMultipartUploadRequest	withArchiveSize(String archiveSize) The total size, in bytes, of the entire archive.
CompleteMultipartUploadRequest	withChecksum(String checksum) The SHA256 tree hash of the entire archive.
CompleteMultipartUploadRequest	withUploadId(String uploadId) The upload ID of the multipart upload.
CompleteMultipartUploadRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteMultipartUploadRequest

public CompleteMultipartUploadRequest()

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

CompleteMultipartUploadRequest

public CompleteMultipartUploadRequest(String vaultName,
                              String uploadId,
                              String archiveSize,
                              String checksum)

Constructs a new CompleteMultipartUploadRequest 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.

archiveSize - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

checksum - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

CompleteMultipartUploadRequest

public CompleteMultipartUploadRequest(String accountId,
                              String vaultName,
                              String uploadId,
                              String archiveSize,
                              String checksum)

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

Parameters:

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.

vaultName - The name of the vault.

uploadId - The upload ID of the multipart upload.

archiveSize - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

checksum - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

Method Detail

getAccountId

public String getAccountId()

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.

Returns:

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.

setAccountId

public void setAccountId(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.

Parameters:

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.

withAccountId

public CompleteMultipartUploadRequest withAccountId(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.

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

Parameters:

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.

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 CompleteMultipartUploadRequest 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 CompleteMultipartUploadRequest 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.

getArchiveSize

public String getArchiveSize()

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

Returns:

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

setArchiveSize

public void setArchiveSize(String archiveSize)

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

Parameters:

archiveSize - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

withArchiveSize

public CompleteMultipartUploadRequest withArchiveSize(String archiveSize)

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

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

Parameters:

archiveSize - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

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 entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

Returns:

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

setChecksum

public void setChecksum(String checksum)

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

Parameters:

checksum - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

withChecksum

public CompleteMultipartUploadRequest withChecksum(String checksum)

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

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

Parameters:

checksum - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

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

clone

public CompleteMultipartUploadRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()