Class AbortMultipartUploadRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Required Parameters: BucketName, Key, UploadId
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionAbortMultipartUploadRequest
(String bucketName, String key, String uploadId) Constructs a new request to abort a multipart upload. -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the bucket containing the multipart upload to abort.getKey()
Returns the key of the multipart upload to abort.Returns the ID of the upload to abort.boolean
Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.void
setBucketName
(String value) Sets the name of the bucket containing the multipart upload to abort.void
Sets the key of the multipart upload to abort.void
setRequesterPays
(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.void
setUploadId
(String uploadId) Sets the ID of the upload to abort.withBucketName
(String bucketName) Sets the name of the bucket containing the multipart upload to abort and returns the updated object so that additional calls can be chained together.Sets the key of the multipart upload to abort and returns the updated AbortMultipartUploadRequest object so that additional method calls can be chained together.withRequesterPays
(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.withUploadId
(String uploadId) Sets the ID of the multipart upload to abort, and returns this updated AbortMultipartUploadRequest 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 Details
-
AbortMultipartUploadRequest
Constructs a new request to abort a multipart upload.- Parameters:
bucketName
- The name of the bucket containing the multipart upload to abort.key
- The key of the multipart upload to abort.uploadId
- The ID of the multipart upload to abort.
-
-
Method Details
-
getBucketName
Returns the name of the bucket containing the multipart upload to abort. -
setBucketName
Sets the name of the bucket containing the multipart upload to abort. -
withBucketName
Sets the name of the bucket containing the multipart upload to abort and returns the updated object so that additional calls can be chained together.- Parameters:
bucketName
- The name of the bucket containing the multipart upload to abort.- Returns:
- The updated AbortMultipartUploadRequest object.
-
getKey
Returns the key of the multipart upload to abort.- Returns:
- The key of the multipart upload to abort.
-
setKey
Sets the key of the multipart upload to abort.- Parameters:
key
- The key of the multipart upload to abort.
-
withKey
Sets the key of the multipart upload to abort and returns the updated AbortMultipartUploadRequest object so that additional method calls can be chained together.- Parameters:
key
- The key of the multipart upload to abort.- Returns:
- The updated AbortMultipartUploadRequest.
-
getUploadId
Returns the ID of the upload to abort.- Returns:
- the ID of the upload to abort.
-
setUploadId
Sets the ID of the upload to abort. -
withUploadId
Sets the ID of the multipart upload to abort, and returns this updated AbortMultipartUploadRequest object so that additional method calls can be chained together.- Parameters:
uploadId
- The ID of the multipart upload to abort.- Returns:
- The updated AbortMultipartUploadRequest 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
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 AbortMultipartUploadRequest 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 AbortMultipartUploadRequest object.
-