com.ibm.cloud.objectstorage.services.s3.model

Class AbortMultipartUploadRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.AbortMultipartUploadRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class AbortMultipartUploadRequest
extends AmazonWebServiceRequest
implements Serializable

The AbortMultipartUploadRequest contains the parameters used for the AbortMultipartUpload method.

Required Parameters: BucketName, Key, UploadId

See Also:

AmazonS3.abortMultipartUpload(AbortMultipartUploadRequest), Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AbortMultipartUploadRequest(String bucketName, String key, String uploadId) Constructs a new request to abort a multipart upload.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() The bucket name to which the upload was taking place.
String	getKey() Returns the key of the multipart upload to abort.
String	getUploadId() Returns the ID of the upload to abort.
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 value) Sets the name of the bucket containing the multipart upload to abort.
void	setKey(String key) 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.
AbortMultipartUploadRequest	withBucketName(String bucketName) The bucket name to which the upload was taking place.
AbortMultipartUploadRequest	withKey(String key) Sets the key of the multipart upload to abort and returns the updated AbortMultipartUploadRequest object so that additional method calls can be chained together.
AbortMultipartUploadRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
AbortMultipartUploadRequest	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.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbortMultipartUploadRequest

public AbortMultipartUploadRequest(String bucketName,
                                   String key,
                                   String uploadId)

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 Detail

getBucketName

public String getBucketName()

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

Returns:

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

setBucketName

public void setBucketName(String value)

Sets the name of the bucket containing the multipart upload to abort.

withBucketName

public AbortMultipartUploadRequest withBucketName(String bucketName)

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

Parameters:

bucketName - The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

Returns:

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

getKey

public String getKey()

Returns the key of the multipart upload to abort.

Returns:

The key of the multipart upload to abort.

setKey

public void setKey(String key)

Sets the key of the multipart upload to abort.

Parameters:

key - The key of the multipart upload to abort.

withKey

public AbortMultipartUploadRequest withKey(String key)

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

public String getUploadId()

Returns the ID of the upload to abort.

Returns:

the ID of the upload to abort.

setUploadId

public void setUploadId(String uploadId)

Sets the ID of the upload to abort.

withUploadId

public AbortMultipartUploadRequest 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.

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

public AbortMultipartUploadRequest 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 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.