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

Class CopyObjectResult

java.lang.Object

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

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

All Implemented Interfaces:

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

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

Contains the data returned by Amazon S3 from the AmazonS3.copyObject(CopyObjectRequest copyObjectRequest) call. This result may be ignored if not needed; otherwise, use this result to access information about the new object created from the copyObject call.

See Also:

AmazonS3Client.copyObject(String, String, String, String), AmazonS3Client.copyObject(com.ibm.cloud.objectstorage.services.s3.model.CopyObjectRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CopyObjectResult()

Method Summary

Modifier and Type	Method and Description
String	getETag() Gets the ETag value for the new object that was created in the associated CopyObjectRequest.
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.
Date	getLastModifiedDate() Gets the date the newly copied object was last modified.
String	getVersionId() Gets the version ID of the newly copied object.
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setETag(String etag) Sets the ETag value for the new object that was created from the associated copy object 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	setLastModifiedDate(Date lastModifiedDate) Sets the date the newly copied object was last modified.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
void	setVersionId(String versionId) Sets the version ID of the newly copied 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

CopyObjectResult

public CopyObjectResult()

Method Detail

getETag

public String getETag()

Gets the ETag value for the new object that was created in the associated CopyObjectRequest.

Returns:

The ETag value for the new object.

See Also:

CopyObjectResult.setETag(String)

setETag

public void setETag(String etag)

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

Parameters:

etag - The ETag value for the new object.

See Also:

CopyObjectResult.getETag()

getLastModifiedDate

public Date getLastModifiedDate()

Gets the date the newly copied object was last modified.

Returns:

The date the newly copied object was last modified.

See Also:

CopyObjectResult.setLastModifiedDate(Date)

setLastModifiedDate

public void setLastModifiedDate(Date lastModifiedDate)

Sets the date the newly copied object was last modified.

Parameters:

lastModifiedDate - The date the new, copied object was last modified.

See Also:

CopyObjectResult.getLastModifiedDate()

getVersionId

public String getVersionId()

Description copied from interface: com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult

Gets the version ID of the newly copied object. This field is only present if object versioning has been enabled for the bucket the object was copied to.

Specified by:

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

Returns:

The version ID of the newly copied object.

See Also:

CopyObjectResult.setVersionId(String), CompleteMultipartUploadResult.getVersionId(), PutObjectResult.getVersionId()

setVersionId

public void setVersionId(String versionId)

Description copied from interface: com.ibm.cloud.objectstorage.services.s3.internal.S3VersionResult

Sets the version ID of the newly copied object.

Specified by:

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

Parameters:

versionId - The version ID of the newly copied object.

See Also:

CopyObjectResult.getVersionId(), CompleteMultipartUploadResult.getVersionId(), PutObjectResult.getVersionId()

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.