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

Class InitiateMultipartUploadResult

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.SSEResultBase

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

All Implemented Interfaces:

S3RequesterChargedResult, ServerSideEncryptionResult, Serializable

public class InitiateMultipartUploadResult
extends SSEResultBase
implements S3RequesterChargedResult, Serializable

Contains the results of initiating a multipart upload, particularly the unique ID of the new multipart upload.

See Also:

AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
InitiateMultipartUploadResult()

Method Summary

Modifier and Type	Method and 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() The name of the bucket to which the 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) /**
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.ibm.cloud.objectstorage.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 Detail

InitiateMultipartUploadResult

public InitiateMultipartUploadResult()

Method Detail

getBucketName

public String getBucketName()

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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.

Returns:

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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.

setBucketName

public void setBucketName(String bucketName)

/**

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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 name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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.

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: 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 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: 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 S3RequesterChargedResult

Parameters:

isRequesterCharged - Indicates requester is charged for this operation.