Class AbortMultipartUploadRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.s3.model.AbortMultipartUploadRequest
All Implemented Interfaces:
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:
  • Constructor Details

    • 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 Details

    • getBucketName

      public String getBucketName()
      Returns the name of the bucket containing the multipart upload to abort.
    • setBucketName

      public void setBucketName(String value)
      Sets the name of the bucket containing the multipart upload to abort.
    • withBucketName

      public AbortMultipartUploadRequest 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.
      Parameters:
      bucketName - The name of the bucket containing the multipart upload to abort.
      Returns:
      The updated AbortMultipartUploadRequest object.
    • 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.