Class CompleteMultipartUploadRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.s3.model.CompleteMultipartUploadRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable
Container for the parameters of the CompleteMultipartUpload operation.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
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CompleteMultipartUploadRequest()
CompleteMultipartUploadRequest(String bucketName, String key, String uploadId, List<PartETag> partETags)
Constructs a new request to complete a multipart upload.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(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
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
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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, 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 Detail
-
CompleteMultipartUploadRequest
public CompleteMultipartUploadRequest()
-
CompleteMultipartUploadRequest
public CompleteMultipartUploadRequest(String bucketName, String key, String uploadId, List<PartETag> partETags)
Constructs a new request to complete a multipart upload.- Parameters:
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.
-
-
Method Detail
-
getBucketName
public String getBucketName()
Returns the name of the bucket containing the multipart upload to complete.- Returns:
- The name of the bucket containing the multipart upload to complete.
-
setBucketName
public void setBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload to complete.- Parameters:
bucketName
- The name of the bucket containing the multipart upload to complete.
-
withBucketName
public 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.- Parameters:
bucketName
- The name of the bucket containing the multipart upload to complete.- Returns:
- The updated CompleteMultipartUploadRequest.
-
getKey
public String getKey()
Returns the key under which the multipart upload to complete is stored.- Returns:
- The key under which the multipart upload to complete is stored.
-
setKey
public void setKey(String key)
Sets the key under which the multipart upload to complete is stored.- Parameters:
key
- The key under which the multipart upload to complete is stored.
-
withKey
public 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.- Parameters:
key
- The key under which the multipart upload to complete is stored.- Returns:
- This updated CompleteMultipartUploadRequest object.
-
getUploadId
public String getUploadId()
Returns the ID of the multipart upload to complete.- Returns:
- The ID of the multipart upload to complete.
-
setUploadId
public void setUploadId(String uploadId)
Sets the ID of the multipart upload to complete.- Parameters:
uploadId
- The ID of the multipart upload to complete.
-
withUploadId
public 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.- Parameters:
uploadId
- The ID of the multipart upload to complete.- Returns:
- This updated CompleteMultipartUploadRequest object.
-
getPartETags
public List<PartETag> getPartETags()
Returns the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.- Returns:
- The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.
-
setPartETags
public void setPartETags(List<PartETag> partETags)
Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.- Parameters:
partETags
- The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.
-
withPartETags
public 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.- Parameters:
partETags
- The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.- Returns:
- This updated CompleteMultipartUploadRequest object.
-
withPartETags
public 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.- Parameters:
uploadPartResults
- The list of results from the individual part uploads in the multipart upload to complete.- Returns:
- This updated CompleteMultipartUploadRequest object.
-
withPartETags
public 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.- Parameters:
uploadPartResultsCollection
- The list of results from the individual part uploads in the multipart upload to complete.- Returns:
- This updated CompleteMultipartUploadRequest object.
-
isRequesterPays
public boolean isRequesterPays()
Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.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
- Returns:
- true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.
-
setRequesterPays
public void setRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket.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.
- Parameters:
isRequesterPays
- Enable Requester Pays option for the operation.
-
withRequesterPays
public CompleteMultipartUploadRequest withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained together.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.
- Parameters:
isRequesterPays
- Enable Requester Pays option for the operation.- Returns:
- The updated CompleteMultipartUploadRequest object.
-
-