com.amazonaws.services.glacier.model

Class UploadArchiveRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.UploadArchiveRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UploadArchiveRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UploadArchive operation.

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums .

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

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 an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.uploadArchive(UploadArchiveRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
UploadArchiveRequest	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	getArchiveDescription() The optional description of the archive you are uploading.
InputStream	getBody() The data to upload.
String	getChecksum() The SHA256 tree hash of the data being uploaded.
Long	getContentLength() Returns the value of the ContentLength property for this object.
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	setArchiveDescription(String archiveDescription) The optional description of the archive you are uploading.
void	setBody(InputStream body) The data to upload.
void	setChecksum(String checksum) The SHA256 tree hash of the data being uploaded.
void	setContentLength(Long contentLength) Sets the value of the ContentLength property for this object.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UploadArchiveRequest	withAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
UploadArchiveRequest	withArchiveDescription(String archiveDescription) The optional description of the archive you are uploading.
UploadArchiveRequest	withBody(InputStream body) The data to upload.
UploadArchiveRequest	withChecksum(String checksum) The SHA256 tree hash of the data being uploaded.
UploadArchiveRequest	withContentLength(Long contentLength) Sets the value of the ContentLength property for this object.
UploadArchiveRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadArchiveRequest

public UploadArchiveRequest()

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

UploadArchiveRequest

public UploadArchiveRequest(String vaultName,
                    String archiveDescription,
                    String checksum,
                    InputStream body)

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

Parameters:

vaultName - The name of the vault.

archiveDescription - The optional description of the archive you are uploading.

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

body - The data to upload.

UploadArchiveRequest

public UploadArchiveRequest(String vaultName,
                    String accountId,
                    String archiveDescription,
                    String checksum,
                    InputStream body)

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

Parameters:

vaultName - The name of the vault.

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.

archiveDescription - The optional description of the archive you are uploading.

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

body - The data to upload.

Method Detail

getContentLength

public Long getContentLength()

Returns the value of the ContentLength property for this object.

Returns:

The value of the ContentLength property for this object.

setContentLength

public void setContentLength(Long contentLength)

Sets the value of the ContentLength property for this object.

Parameters:

contentLength - The new value for the ContentLength property for this object.

withContentLength

public UploadArchiveRequest withContentLength(Long contentLength)

Sets the value of the ContentLength property for this object.

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

Parameters:

contentLength - The new value for the ContentLength property for this object.

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

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

getArchiveDescription

public String getArchiveDescription()

The optional description of the archive you are uploading.

Returns:

The optional description of the archive you are uploading.

setArchiveDescription

public void setArchiveDescription(String archiveDescription)

The optional description of the archive you are uploading.

Parameters:

archiveDescription - The optional description of the archive you are uploading.

withArchiveDescription

public UploadArchiveRequest withArchiveDescription(String archiveDescription)

The optional description of the archive you are uploading.

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

Parameters:

archiveDescription - The optional description of the archive you are uploading.

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

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 UploadArchiveRequest 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

clone

public UploadArchiveRequest 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()