Class UploadArchiveRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Provides options to add an archive to a vault.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for 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
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
TheAccountId
value is the AWS account ID of the account that owns the vault.The optional description of the archive you are uploading.getBody()
The data to upload.The SHA256 tree hash of the data being uploaded.The content length of the archive to upload.The name of the vault.int
hashCode()
void
setAccountId
(String accountId) TheAccountId
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) The content length of the archive to upload.void
setVaultName
(String vaultName) The name of the vault.toString()
Returns a string representation of this object; useful for testing and debugging.withAccountId
(String accountId) TheAccountId
value is the AWS account ID of the account that owns the vault.withArchiveDescription
(String archiveDescription) The optional description of the archive you are uploading.withBody
(InputStream body) The data to upload.withChecksum
(String checksum) The SHA256 tree hash of the data being uploaded.withContentLength
(Long contentLength) The content length of the archive to upload.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
-
Constructor Details
-
UploadArchiveRequest
public UploadArchiveRequest()Default constructor for UploadArchiveRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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
- TheAccountId
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.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 Details
-
setVaultName
The name of the vault.
- Parameters:
vaultName
- The name of the vault.
-
getVaultName
The name of the vault.
- Returns:
- The name of the vault.
-
withVaultName
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.
-
setAccountId
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
- TheAccountId
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
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
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
- TheAccountId
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.
-
setArchiveDescription
The optional description of the archive you are uploading.
- Parameters:
archiveDescription
- The optional description of the archive you are uploading.
-
getArchiveDescription
The optional description of the archive you are uploading.
- Returns:
- The optional description of the archive you are uploading.
-
withArchiveDescription
The optional description of the archive you are uploading.
- Parameters:
archiveDescription
- The optional description of the archive you are uploading.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChecksum
The SHA256 tree hash of the data being uploaded.
- Parameters:
checksum
- The SHA256 tree hash of the data being uploaded.
-
getChecksum
The SHA256 tree hash of the data being uploaded.
- Returns:
- The SHA256 tree hash of the data being uploaded.
-
withChecksum
The SHA256 tree hash of the data being uploaded.
- Parameters:
checksum
- The SHA256 tree hash of the data being uploaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBody
The data to upload.
- Parameters:
body
- The data to upload.
-
getBody
The data to upload.
- Returns:
- The data to upload.
-
withBody
The data to upload.
- Parameters:
body
- The data to upload.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setContentLength
The content length of the archive to upload.- Parameters:
contentLength
- The content length of the archive to upload.
-
getContentLength
The content length of the archive to upload.- Returns:
- The content length of the archive to upload.
-
withContentLength
The content length of the archive to upload.- Parameters:
contentLength
- The content length of the archive to upload.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-