Package 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

Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and 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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
CompleteMultipartUploadRequest()	Default constructor for 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

Modifier and Type	Method	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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteMultipartUploadRequest

public CompleteMultipartUploadRequest()

Default constructor for CompleteMultipartUploadRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 apos-apos (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 (apos-apos) 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

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 apos-apos (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 (apos-apos) 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 apos-apos (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 (apos-apos) in the ID.

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 apos-apos (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 (apos-apos) 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 apos-apos (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 (apos-apos) 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 apos-apos (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 (apos-apos) 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 apos-apos (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 (apos-apos) in the ID.

Returns:

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

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

withVaultName

public CompleteMultipartUploadRequest withVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

Returns:

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

setUploadId

public void setUploadId(String uploadId)

The upload ID of the multipart upload.

Parameters:

uploadId - The upload ID of the multipart upload.

getUploadId

public String getUploadId()

The upload ID of the multipart upload.

Returns:

The upload ID of the multipart upload.

withUploadId

public CompleteMultipartUploadRequest withUploadId(String uploadId)

The upload ID of the multipart upload.

Parameters:

uploadId - The upload ID of the multipart upload.

Returns:

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

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.

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.

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.

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:

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

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.

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.

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.

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:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode 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()