Package com.amazonaws.services.s3.model

Class InitiateMultipartUploadResult

java.lang.Object
com.amazonaws.services.s3.internal.SSEResultBase
com.amazonaws.services.s3.model.InitiateMultipartUploadResult
All Implemented Interfaces:
com.amazonaws.services.s3.internal.S3RequesterChargedResult, com.amazonaws.services.s3.internal.ServerSideEncryptionResult, Serializable
public class InitiateMultipartUploadResult extends com.amazonaws.services.s3.internal.SSEResultBase implements com.amazonaws.services.s3.internal.S3RequesterChargedResult, Serializable
Contains the results of initiating a multipart upload, particularly the unique ID of the new multipart upload.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    InitiateMultipartUploadResult()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Date
    getAbortDate()
    Date when multipart upload will become eligible for abort operation by lifecycle.
    String
    getAbortRuleId()
    Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
    String
    getBucketName()
    Returns the name of the bucket in which the new multipart upload was initiated.
    String
    getKey()
    Returns the object key for which the multipart upload was initiated.
    String
    getUploadId()
    Returns the initiated multipart upload ID.
    boolean
    isRequesterCharged()
    Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
    void
    setAbortDate(Date abortDate)
    Date when multipart upload will become eligible for abort operation by lifecycle.
    void
    setAbortRuleId(String abortRuleId)
    Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
    void
    setBucketName(String bucketName)
    Sets the name of the bucket in which the new multipart upload was initiated.
    void
    setKey(String key)
    Sets the object key for which the multipart upload was initiated.
    void
    setRequesterCharged(boolean isRequesterCharged)
    Used for conducting this operation from a Requester Pays Bucket.
    void
    setUploadId(String uploadId)
    Sets the initiated multipart upload ID.

    Methods inherited from class com.amazonaws.services.s3.internal.SSEResultBase

    getServerSideEncryption, getSSEAlgorithm, getSSECustomerAlgorithm, getSSECustomerKeyMd5, setSSEAlgorithm, setSSECustomerAlgorithm, setSSECustomerKeyMd5

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • InitiateMultipartUploadResult

      public InitiateMultipartUploadResult()

  • Method Details

    • getBucketName

      public String getBucketName()
      Returns the name of the bucket in which the new multipart upload was initiated.
      Returns:
      The name of the bucket in which the new multipart upload was initiated.

    • setBucketName

      public void setBucketName(String bucketName)
      Sets the name of the bucket in which the new multipart upload was initiated.
      Parameters:
      bucketName - The name of the bucket in which the new multipart upload was initiated.

    • getKey

      public String getKey()
      Returns the object key for which the multipart upload was initiated.
      Returns:
      The object key for which the multipart upload was initiated.

    • setKey

      public void setKey(String key)
      Sets the object key for which the multipart upload was initiated.
      Parameters:
      key - The object key for which the multipart upload was initiated.

    • getUploadId

      public String getUploadId()
      Returns the initiated multipart upload ID.
      Returns:
      the initiated multipart upload ID.

    • setUploadId

      public void setUploadId(String uploadId)
      Sets the initiated multipart upload ID.
      Parameters:
      uploadId - The initiated multipart upload ID.

    • getAbortDate

      public Date getAbortDate()
      Date when multipart upload will become eligible for abort operation by lifecycle.
      Returns:
      The date when the upload will be eligible for abort.

    • setAbortDate

      public void setAbortDate(Date abortDate)
      Date when multipart upload will become eligible for abort operation by lifecycle.
      Parameters:
      abortDate - The date when the upload will be eligible for abort.

    • getAbortRuleId

      public String getAbortRuleId()
      Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
      Returns:
      Rule ID

    • setAbortRuleId

      public void setAbortRuleId(String abortRuleId)
      Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
      Parameters:
      abortRuleId - Rule ID

    • isRequesterCharged

      public boolean isRequesterCharged()
      Description copied from interface: com.amazonaws.services.s3.internal.S3RequesterChargedResult
      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 of operation 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

      Specified by:
      isRequesterCharged in interface com.amazonaws.services.s3.internal.S3RequesterChargedResult
      Returns:
      true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

    • setRequesterCharged

      public void setRequesterCharged(boolean isRequesterCharged)
      Description copied from interface: com.amazonaws.services.s3.internal.S3RequesterChargedResult
      Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for conducting the operation from the bucket.

      If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

      Specified by:
      setRequesterCharged in interface com.amazonaws.services.s3.internal.S3RequesterChargedResult
      Parameters:
      isRequesterCharged - Indicates requester is charged for this operation.