Class InitiateMultipartUploadRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.InitiateMultipartUploadRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class InitiateMultipartUploadRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Provides options for initiating a multipart upload to an Amazon Glacier vault.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
InitiateMultipartUploadRequest()	Default constructor for InitiateMultipartUploadRequest object.
InitiateMultipartUploadRequest(String vaultName, String archiveDescription, String partSize)	Constructs a new InitiateMultipartUploadRequest object.
InitiateMultipartUploadRequest(String accountId, String vaultName, String archiveDescription, String partSize)	Constructs a new InitiateMultipartUploadRequest object.

Method Summary

Modifier and Type	Method	Description
InitiateMultipartUploadRequest	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 archive description that you are uploading in parts.
String	getPartSize()	The size of each part except the last, in bytes.
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 archive description that you are uploading in parts.
void	setPartSize(String partSize)	The size of each part except the last, in bytes.
void	setVaultName(String vaultName)	The name of the vault.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
InitiateMultipartUploadRequest	withAccountId(String accountId)	The AccountId value is the AWS account ID of the account that owns the vault.
InitiateMultipartUploadRequest	withArchiveDescription(String archiveDescription)	The archive description that you are uploading in parts.
InitiateMultipartUploadRequest	withPartSize(String partSize)	The size of each part except the last, in bytes.
InitiateMultipartUploadRequest	withVaultName(String vaultName)	The name of the vault.

Methods inherited from class 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 Object

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

Constructor Details

InitiateMultipartUploadRequest

public InitiateMultipartUploadRequest()

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

InitiateMultipartUploadRequest

public InitiateMultipartUploadRequest(String vaultName,
 String archiveDescription,
 String partSize)

Constructs a new InitiateMultipartUploadRequest 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 archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

partSize - The size of each part except the last, in bytes. The last part can be smaller than this part size.

InitiateMultipartUploadRequest

public InitiateMultipartUploadRequest(String accountId,
 String vaultName,
 String archiveDescription,
 String partSize)

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

archiveDescription - The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

partSize - The size of each part except the last, in bytes. The last part can be smaller than this part size.

Method Details

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

setArchiveDescription

public void setArchiveDescription(String archiveDescription)

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

Parameters:

archiveDescription - The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

getArchiveDescription

public String getArchiveDescription()

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

Returns:

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

withArchiveDescription

public InitiateMultipartUploadRequest withArchiveDescription(String archiveDescription)

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

Parameters:

archiveDescription - The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

Returns:

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

setPartSize

public void setPartSize(String partSize)

The size of each part except the last, in bytes. The last part can be smaller than this part size.

Parameters:

partSize - The size of each part except the last, in bytes. The last part can be smaller than this part size.

getPartSize

public String getPartSize()

The size of each part except the last, in bytes. The last part can be smaller than this part size.

Returns:

The size of each part except the last, in bytes. The last part can be smaller than this part size.

withPartSize

public InitiateMultipartUploadRequest withPartSize(String partSize)

The size of each part except the last, in bytes. The last part can be smaller than this part size.

Parameters:

partSize - The size of each part except the last, in bytes. The last part can be smaller than this part size.

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