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

Class CopyResult

java.lang.Object

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

public class CopyResult
extends Object

Contains information returned by Amazon S3 for a completed copy operation.

See TransferManager for more information about creating transfers.

See Also:

TransferManager.copy(String, String, String, String), TransferManager.copy(com.ibm.cloud.objectstorage.services.s3.model.CopyObjectRequest)

Constructor Summary

Constructors

Constructor and Description
CopyResult()

Method Summary

Modifier and Type	Method and Description
String	getDestinationBucketName() Gets the destination bucket name which will contain the new, copied object.
String	getDestinationKey() Gets the destination bucket key under which the new, copied object will be stored.
String	getETag() Returns the entity tag identifying the new object.
String	getSourceBucketName() Gets the name of the bucket containing the source object to be copied.
String	getSourceKey() Gets the source bucket key under which the source object to be copied is stored.
String	getVersionId() Returns the version ID of the new object.
void	setDestinationBucketName(String destinationBucketName) Sets the destination bucket name which will contain the new, copied object.
void	setDestinationKey(String destinationKey) Sets the destination bucket key under which the new, copied object will be stored.
void	setETag(String etag) Sets the entity tag identifying the new object.
void	setSourceBucketName(String sourceBucketName) Sets the name of the bucket containing the source object to be copied.
void	setSourceKey(String sourceKey) Sets the source bucket key under which the source object to be copied is stored.
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 java.lang.Object

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

Constructor Detail

CopyResult

public CopyResult()

Method Detail

getSourceBucketName

public String getSourceBucketName()

Gets the name of the bucket containing the source object to be copied.

Returns:

The name of the bucket containing the source object to be copied.

See Also:

CopyResult.setSourceBucketName(String sourceBucketName)

setSourceBucketName

public void setSourceBucketName(String sourceBucketName)

Sets the name of the bucket containing the source object to be copied.

Parameters:

sourceBucketName - The name of the bucket containing the source object to be copied.

See Also:

CopyResult.getSourceBucketName()

getSourceKey

public String getSourceKey()

Gets the source bucket key under which the source object to be copied is stored.

Returns:

The source bucket key under which the source object to be copied is stored.

See Also:

CopyResult.setSourceKey(String sourceKey)

setSourceKey

public void setSourceKey(String sourceKey)

Sets the source bucket key under which the source object to be copied is stored.

Parameters:

sourceKey - The source bucket key under which the source object to be copied is stored.

See Also:

CopyResult.setSourceKey(String sourceKey)

getDestinationBucketName

public String getDestinationBucketName()

Gets the destination bucket name which will contain the new, copied object.

Returns:

The name of the destination bucket which will contain the new, copied object.

See Also:

CopyResult.setDestinationBucketName(String destinationBucketName)

setDestinationBucketName

public void setDestinationBucketName(String destinationBucketName)

Sets the destination bucket name which will contain the new, copied object.

Parameters:

destinationBucketName - The name of the destination bucket which will contain the new, copied object.

See Also:

CopyResult.getDestinationBucketName()

getDestinationKey

public String getDestinationKey()

Gets the destination bucket key under which the new, copied object will be stored.

Returns:

The destination bucket key under which the new, copied object will be stored.

See Also:

CopyResult.setDestinationKey(String destinationKey)

setDestinationKey

public void setDestinationKey(String destinationKey)

Sets the destination bucket key under which the new, copied object will be stored.

Parameters:

destinationKey - The destination bucket key under which the new, copied object will be stored.

See Also:

CopyResult.getDestinationKey()

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. The version ID is only set if versioning has been enabled for the bucket.

Returns:

The version ID of the new object. The version ID is only set 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.