com.obs.services.model

Class CopyObjectRequest

java.lang.Object

com.obs.services.model.PutObjectBasicRequest

com.obs.services.model.CopyObjectRequest

public class CopyObjectRequest
extends PutObjectBasicRequest

Parameters in a request for copying an object

Field Summary

Fields inherited from class com.obs.services.model.PutObjectBasicRequest

acl, bucketName, extensionPermissionMap, objectKey, sseCHeader, sseKmsHeader, successRedirectLocation

Constructor Summary

Constructors

Constructor and Description
CopyObjectRequest()
CopyObjectRequest(String sourceBucketName, String sourceObjectKey, String destinationBucketName, String destinationObjectKey) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getDestinationBucketName() Obtain the destination bucket name.
String	getDestinationObjectKey() Obtain the destination object name.
String	getIfMatchTag() Obtain the ETag verification condition for copying the object: Only when the ETag of the source object is the same as that specified by this parameter, the object can be copied.
Date	getIfModifiedSince() Obtain the time condition for copying the object: Only when the source object is modified after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.
String	getIfNoneMatchTag() Obtain the ETag verification condition for copying the object: Only when the ETag of the source object is different from that specified by this parameter, the object will be copied.
Date	getIfUnmodifiedSince() Obtain the time condition for copying the object: Only when the source object remains unchanged after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.
ObjectMetadata	getNewObjectMetadata() Obtain the properties, including customized metadata, of the destination object.
String	getSourceBucketName() Obtain the source bucket name.
String	getSourceObjectKey() Obtain the source object name.
SseCHeader	getSseCHeaderDestination() Deprecated.
SseCHeader	getSseCHeaderSource() Obtain SSE-C decryption headers of the source object.
String	getVersionId() Obtain the version ID of the source object.
boolean	isReplaceMetadata() Obtain the identifier specifying whether to replace properties of the destination object.
void	setDestinationBucketName(String destinationBucketName) Set the destination bucket name.
void	setDestinationObjectKey(String destinationObjectKey) Set the destination object name.
void	setIfMatchTag(String ifMatchTag) Set the ETag verification condition for copying the object: Only when the ETag of the source object is the same as that specified by this parameter, the object can be copied.
void	setIfModifiedSince(Date ifModifiedSince) Set the time condition for copying the object: Only when the source object is modified after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.
void	setIfNoneMatchTag(String ifNoneMatchTag) Set the ETag verification condition for copying the object: Only when the ETag of the source object is different from that specified by this parameter, the object will be copied.
void	setIfUnmodifiedSince(Date ifUnmodifiedSince) Set the time condition for copying the object: Only when the source object remains unchanged after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.
void	setNewObjectMetadata(ObjectMetadata newObjectMetadata) Set the properties, including customized metadata, of the destination object.
void	setReplaceMetadata(boolean replaceMetadata) Set the identifier specifying whether to replace properties of the destination object.
void	setSourceBucketName(String sourceBucketName) Set the source bucket name.
void	setSourceObjectKey(String sourceObjectKey) Set the source object name.
void	setSseCHeaderDestination(SseCHeader sseCHeaderDestination) Deprecated.
void	setSseCHeaderSource(SseCHeader sseCHeaderSource) Set SSE-C decryption headers of the source object.
void	setVersionId(String versionId) Set the version ID for the source object.
String	toString()

Methods inherited from class com.obs.services.model.PutObjectBasicRequest

getAcl, getAllGrantPermissions, getBucketName, getDomainIdsByGrantPermission, getExtensionPermissionMap, getGrantPermissionsByDomainId, getObjectKey, getSseCHeader, getSseKmsHeader, getSuccessRedirectLocation, grantExtensionPermission, setAcl, setBucketName, setExtensionPermissionMap, setObjectKey, setSseCHeader, setSseKmsHeader, setSuccessRedirectLocation, withdrawExtensionPermission, withdrawExtensionPermissions

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyObjectRequest

public CopyObjectRequest(String sourceBucketName,
                 String sourceObjectKey,
                 String destinationBucketName,
                 String destinationObjectKey)

Constructor

Parameters:

sourceBucketName - Source bucket name

sourceObjectKey - Source object name

destinationBucketName - Destination bucket name

destinationObjectKey - Destination object name

CopyObjectRequest

public CopyObjectRequest()

Method Detail

getSseCHeaderSource

public SseCHeader getSseCHeaderSource()

Obtain SSE-C decryption headers of the source object.

Returns:

SSE-C decryption headers of the source object

setSseCHeaderSource

public void setSseCHeaderSource(SseCHeader sseCHeaderSource)

Set SSE-C decryption headers of the source object.

Parameters:

sseCHeaderSource - SSE-C decryption headers of the source object

getSseCHeaderDestination

@Deprecated
public SseCHeader getSseCHeaderDestination()

Deprecated.

Obtain SSE-C encryption headers of the destination object.

Returns:

SSE-C encryption headers

setSseCHeaderDestination

@Deprecated
public void setSseCHeaderDestination(SseCHeader sseCHeaderDestination)

Deprecated.

Set SSE-C encryption headers for the destination object.

Parameters:

sseCHeaderDestination - SSE-C encryption headers

getIfModifiedSince

public Date getIfModifiedSince()

Obtain the time condition for copying the object: Only when the source object is modified after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.

Returns:

Time condition set for copying the object

setIfModifiedSince

public void setIfModifiedSince(Date ifModifiedSince)

Set the time condition for copying the object: Only when the source object is modified after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifModifiedSince - Time condition set for copying the object

getIfUnmodifiedSince

public Date getIfUnmodifiedSince()

Obtain the time condition for copying the object: Only when the source object remains unchanged after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.

Returns:

Time condition set for copying the object

setIfUnmodifiedSince

public void setIfUnmodifiedSince(Date ifUnmodifiedSince)

Set the time condition for copying the object: Only when the source object remains unchanged after the point in time specified by this parameter, it can be copied; otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifUnmodifiedSince - Time condition set for copying the object

getIfMatchTag

public String getIfMatchTag()

Obtain the ETag verification condition for copying the object: Only when the ETag of the source object is the same as that specified by this parameter, the object can be copied. Otherwise, "412 Precondition Failed" will be returned.

Returns:

ETag verification condition set for copying the object

setIfMatchTag

public void setIfMatchTag(String ifMatchTag)

Set the ETag verification condition for copying the object: Only when the ETag of the source object is the same as that specified by this parameter, the object can be copied. Otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifMatchTag - ETag verification condition set for copying the object

getIfNoneMatchTag

public String getIfNoneMatchTag()

Obtain the ETag verification condition for copying the object: Only when the ETag of the source object is different from that specified by this parameter, the object will be copied. Otherwise, "412 Precondition Failed" will be returned.

Returns:

ETag verification condition set for copying the object

setIfNoneMatchTag

public void setIfNoneMatchTag(String ifNoneMatchTag)

Set the ETag verification condition for copying the object: Only when the ETag of the source object is different from that specified by this parameter, the object will be copied. Otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifNoneMatchTag - ETag verification condition set for copying the object

getVersionId

public String getVersionId()

Obtain the version ID of the source object.

Returns:

Version ID of the source object

setVersionId

public void setVersionId(String versionId)

Set the version ID for the source object.

Parameters:

versionId - Version ID of the source object

getSourceBucketName

public String getSourceBucketName()

Obtain the source bucket name.

Returns:

Source bucket name

setSourceBucketName

public void setSourceBucketName(String sourceBucketName)

Set the source bucket name.

Parameters:

sourceBucketName - Source bucket name

getSourceObjectKey

public String getSourceObjectKey()

Obtain the source object name.

Returns:

Source object name

setSourceObjectKey

public void setSourceObjectKey(String sourceObjectKey)

Set the source object name.

Parameters:

sourceObjectKey - Source object name

getDestinationBucketName

public String getDestinationBucketName()

Obtain the destination bucket name.

Returns:

Destination bucket name

setDestinationBucketName

public void setDestinationBucketName(String destinationBucketName)

Set the destination bucket name.

Parameters:

destinationBucketName - Destination bucket name

getDestinationObjectKey

public String getDestinationObjectKey()

Obtain the destination object name.

Returns:

Destination object name

setDestinationObjectKey

public void setDestinationObjectKey(String destinationObjectKey)

Set the destination object name.

Parameters:

destinationObjectKey - Destination object name

getNewObjectMetadata

public ObjectMetadata getNewObjectMetadata()

Obtain the properties, including customized metadata, of the destination object.

Returns:

ObjectMetadata Properties of the destination object

setNewObjectMetadata

public void setNewObjectMetadata(ObjectMetadata newObjectMetadata)

Set the properties, including customized metadata, of the destination object.

Parameters:

newObjectMetadata - Properties of the destination object

isReplaceMetadata

public boolean isReplaceMetadata()

Obtain the identifier specifying whether to replace properties of the destination object. "true" indicates that properties will be replaced (used together with "setNewObjectMetadata") and "false" indicates that the destination object inherits properties from the source object.

Returns:

Identifier specifying whether to replace the properties of the destination object

setReplaceMetadata

public void setReplaceMetadata(boolean replaceMetadata)

Set the identifier specifying whether to replace properties of the destination object. "true" indicates that properties will be replaced (used together with "setNewObjectMetadata") and "false" indicates that the destination object inherits properties from the source object.

Parameters:

replaceMetadata - Identifier specifying whether to replace the properties of the destination object

toString

public String toString()

Overrides:

toString in class Object