public class CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable
If you are performing a complete multipart upload for KMS-encrypted objects, you need to specify the correct region of the bucket on your client and configure AWS Signature Version 4 for added security. For more information on how to do this, see http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify -signature-version
Required Parameters: BucketName, Key, UploadId, PartETags
NOOP
Constructor and Description |
---|
CompleteMultipartUploadRequest() |
CompleteMultipartUploadRequest(String bucketName,
String key,
String uploadId,
List<PartETag> partETags)
Constructs a new request to complete a multipart upload.
|
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
Returns the name of the bucket containing the multipart upload to
complete.
|
String |
getKey()
Returns the key under which the multipart upload to complete is stored.
|
List<PartETag> |
getPartETags()
Returns the list of part numbers and ETags that identify the individual
parts of the multipart upload to complete.
|
String |
getUploadId()
Returns the ID of the multipart upload to complete.
|
boolean |
isRequesterPays()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
void |
setBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload to complete.
|
void |
setKey(String key)
Sets the key under which the multipart upload to complete is stored.
|
void |
setPartETags(List<PartETag> partETags)
Sets the list of part numbers and ETags that identify the individual
parts of the multipart upload to complete.
|
void |
setRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
void |
setUploadId(String uploadId)
Sets the ID of the multipart upload to complete.
|
CompleteMultipartUploadRequest |
withBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload to complete,
and returns this updated CompleteMultipartUploadRequest so that
additional method calls can be chained together.
|
CompleteMultipartUploadRequest |
withKey(String key)
Sets the key under which the multipart upload to complete is stored, and
returns this updated CompleteMultipartUploadRequest object so that
additional method calls can be chained together.
|
CompleteMultipartUploadRequest |
withPartETags(Collection<UploadPartResult> uploadPartResultsCollection)
Sets the list of part numbers and ETags that identify the individual
parts of the multipart upload to complete based on the specified results
from part uploads.
|
CompleteMultipartUploadRequest |
withPartETags(List<PartETag> partETags)
Sets the list of part numbers and ETags that identify the individual
parts of the multipart upload to complete, and returns this updated
CompleteMultipartUploadRequest object so that additional method calls can be chained.
|
CompleteMultipartUploadRequest |
withPartETags(UploadPartResult... uploadPartResults)
Sets the list of part numbers and ETags that identify the individual
parts of the multipart upload to complete based on the specified results
from part uploads.
|
CompleteMultipartUploadRequest |
withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
CompleteMultipartUploadRequest |
withUploadId(String uploadId)
Sets the ID of the multipart upload to complete, and returns this updated
CompleteMultipartUploadRequest object so that additional method calls can
be chained together.
|
addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CompleteMultipartUploadRequest()
public CompleteMultipartUploadRequest(String bucketName, String key, String uploadId, List<PartETag> partETags)
bucketName
- The name of the bucket containing the multipart upload to
complete.key
- The key of the multipart upload to complete.uploadId
- The ID of the multipart upload to complete.partETags
- The list of part numbers and ETags to use when completing the
multipart upload.public String getBucketName()
public void setBucketName(String bucketName)
bucketName
- The name of the bucket containing the multipart upload to
complete.public CompleteMultipartUploadRequest withBucketName(String bucketName)
bucketName
- The name of the bucket containing the multipart upload to
complete.public String getKey()
public void setKey(String key)
key
- The key under which the multipart upload to complete is
stored.public CompleteMultipartUploadRequest withKey(String key)
key
- The key under which the multipart upload to complete is
stored.public String getUploadId()
public void setUploadId(String uploadId)
uploadId
- The ID of the multipart upload to complete.public CompleteMultipartUploadRequest withUploadId(String uploadId)
uploadId
- The ID of the multipart upload to complete.public List<PartETag> getPartETags()
public void setPartETags(List<PartETag> partETags)
partETags
- The list of part numbers and ETags that identify the
individual parts of the multipart upload to complete.public CompleteMultipartUploadRequest withPartETags(List<PartETag> partETags)
partETags
- The list of part numbers and ETags that identify the
individual parts of the multipart upload to complete.public CompleteMultipartUploadRequest withPartETags(UploadPartResult... uploadPartResults)
uploadPartResults
- The list of results from the individual part uploads in the
multipart upload to complete.public CompleteMultipartUploadRequest withPartETags(Collection<UploadPartResult> uploadPartResultsCollection)
uploadPartResultsCollection
- The list of results from the individual part uploads in the
multipart upload to complete.public boolean isRequesterPays()
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket
public void setRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays
- Enable Requester Pays option for the operation.public CompleteMultipartUploadRequest withRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays
- Enable Requester Pays option for the operation.Copyright © 2020. All rights reserved.