com.amazonaws.services.s3.model

Class CompleteMultipartUploadResult

java.lang.Object

com.amazonaws.services.s3.internal.SSEResultBase

com.amazonaws.services.s3.model.CompleteMultipartUploadResult

All Implemented Interfaces:

ObjectExpirationResult, S3RequesterChargedResult, ServerSideEncryptionResult, Serializable

public class CompleteMultipartUploadResult
extends SSEResultBase
implements ObjectExpirationResult, S3RequesterChargedResult, Serializable

The CompleteMultipartUploadResult contains all the information about the CompleteMultipartUpload method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompleteMultipartUploadResult()

Method Summary

Modifier and Type	Method and Description
String	getBucketName() The name of the bucket that contains the newly created object.
String	getETag() Returns the entity tag identifying the new object.
Date	getExpirationTime() Returns the expiration time for this object, or null if it doesn't expire.
String	getExpirationTimeRuleId() Returns the BucketLifecycleConfiguration rule ID for this object's expiration, or null if it doesn't expire.
String	getKey() Gets the key by which the newly created object is stored.
String	getLocation() Returns the URL identifying the new multipart object.
String	getVersionId() Returns the version ID of the new object, only present if versioning has been enabled for the bucket.
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setBucketName(String bucketName) Sets the name of the bucket containing the completed multipart object.
void	setETag(String etag) Sets the entity tag identifying the new object.
void	setExpirationTime(Date expirationTime) Sets the expiration time for the object.
void	setExpirationTimeRuleId(String expirationTimeRuleId) Sets the BucketLifecycleConfiguration rule ID for this object's expiration
void	setKey(String key) Sets the key of the newly created object.
void	setLocation(String location) Sets the URL identifying the new multipart object.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
void	setVersionId(String versionId) Sets the version ID of the new object, only present if versioning has been enabled for the bucket.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteMultipartUploadResult

public CompleteMultipartUploadResult()

Method Detail

getLocation

public String getLocation()

Returns the URL identifying the new multipart object.

Returns:

The URL identifying the new multipart object.

setLocation

public void setLocation(String location)

Sets the URL identifying the new multipart object.

Parameters:

location - The URL identifying the new multipart object.

getBucketName

public String getBucketName()

The name of the bucket that contains the newly created object. 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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Returns:

The name of the bucket that contains the newly created object. 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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket containing the completed multipart object.

Parameters:

bucketName - The name of the bucket containing the completed multipart object.

getKey

public String getKey()

Gets the key by which the newly created object is stored.

setKey

public void setKey(String key)

Sets the key of the newly created object.

getETag

public String getETag()

Returns the entity tag identifying the new object. An entity tag is an opaque string that changes if and only if an object's data changes.

Returns:

An opaque string that changes if and only if an object's data changes.

setETag

public void setETag(String etag)

Sets the entity tag identifying the new object. An entity tag is an opaque string that changes if and only if an object's data changes.

Parameters:

etag - The entity tag.

getVersionId

public String getVersionId()

Returns the version ID of the new object, only present if versioning has been enabled for the bucket.

Returns:

The version ID of the new object, only present if versioning has been enabled for the bucket.

setVersionId

public void setVersionId(String versionId)

Sets the version ID of the new object, only present if versioning has been enabled for the bucket.

Parameters:

versionId - The version ID of the new object, only present if versioning has been enabled for the bucket.

getExpirationTime

public Date getExpirationTime()

Returns the expiration time for this object, or null if it doesn't expire.

Specified by:

getExpirationTime in interface ObjectExpirationResult

setExpirationTime

public void setExpirationTime(Date expirationTime)

Sets the expiration time for the object.

Specified by:

setExpirationTime in interface ObjectExpirationResult

Parameters:

expirationTime - The expiration time for the object.

getExpirationTimeRuleId

public String getExpirationTimeRuleId()

Returns the BucketLifecycleConfiguration rule ID for this object's expiration, or null if it doesn't expire.

Specified by:

getExpirationTimeRuleId in interface ObjectExpirationResult

See Also:

BucketLifecycleConfiguration.Rule.getId()

setExpirationTimeRuleId

public void setExpirationTimeRuleId(String expirationTimeRuleId)

Sets the BucketLifecycleConfiguration rule ID for this object's expiration

Specified by:

setExpirationTimeRuleId in interface ObjectExpirationResult

Parameters:

expirationTimeRuleId - The rule ID for this object's expiration

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.