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

Class PutObjectResult

java.lang.Object

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

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

All Implemented Interfaces:

ObjectExpirationResult, S3RequesterChargedResult, com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult, ServerSideEncryptionResult, Serializable

public class PutObjectResult
extends SSEResultBase
implements ObjectExpirationResult, S3RequesterChargedResult, com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult, Serializable

Contains the data returned by Amazon S3 from the putObject operation.

Use this class to access information about the new object created from the putObject request, such as its ETag and optional version ID.

This class also contains the MD5 hash of the object content calculated on the client-side.

See Also:

AmazonS3Client.putObject(String, String, java.io.File), AmazonS3Client.putObject(String, String, java.io.InputStream, ObjectMetadata), AmazonS3Client.putObject(PutObjectRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutObjectResult()

Method Summary

Modifier and Type	Method and Description
String	getContentMd5() Returns the Base64-encoded MD5 hash of the object content that was calculated on the client-side.
String	getETag() Gets the server-side ETag value for the newly created 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.
ObjectMetadata	getMetadata() Returns the metadata retrieved as a response to AmazonS3Client.putObject(PutObjectRequest) operation.
String	getVersionId() Gets the optional version ID of the newly uploaded object.
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setContentMd5(String contentMd5) Sets the Base64-encoded MD5 hash of the object content that was calculated on the client-side.
void	setETag(String eTag) Sets the ETag value for the new object that was created from the associated putObject request.
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	setMetadata(ObjectMetadata metadata) Sets the metadata retrieved as a response to AmazonS3Client.putObject(PutObjectRequest) operation.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
void	setVersionId(String versionId) Sets the optional version ID of the newly uploaded object.

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

PutObjectResult

public PutObjectResult()

Method Detail

getVersionId

public String getVersionId()

Gets the optional version ID of the newly uploaded object. This field will be set only if object versioning is enabled for the bucket the object was uploaded to.

Specified by:

getVersionId in interface com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult

Returns:

The optional version ID of the newly uploaded object.

See Also:

PutObjectResult.setVersionId(String)

setVersionId

public void setVersionId(String versionId)

Sets the optional version ID of the newly uploaded object.

Specified by:

setVersionId in interface com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult

Parameters:

versionId - The optional version ID of the newly uploaded object.

See Also:

PutObjectResult.getVersionId()

getETag

public String getETag()

Gets the server-side ETag value for the newly created object.

Returns:

The server-side ETag value for the new object.

See Also:

PutObjectResult.setETag(String)

setETag

public void setETag(String eTag)

Sets the ETag value for the new object that was created from the associated putObject request.

Parameters:

eTag - The ETag value for the new object.

See Also:

PutObjectResult.getETag()

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

setContentMd5

public void setContentMd5(String contentMd5)

Sets the Base64-encoded MD5 hash of the object content that was calculated on the client-side.

Parameters:

contentMd5 - The content MD5

getContentMd5

public String getContentMd5()

Returns the Base64-encoded MD5 hash of the object content that was calculated on the client-side. This method returns null if the MD5 validation is disabled and the caller didn't provide the MD5 hash in the ObjectMetadata when sending the PutObjectRequest.

getMetadata

public ObjectMetadata getMetadata()

Returns the metadata retrieved as a response to AmazonS3Client.putObject(PutObjectRequest) operation.

setMetadata

public void setMetadata(ObjectMetadata metadata)

Sets the metadata retrieved as a response to AmazonS3Client.putObject(PutObjectRequest) operation.

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.