com.obs.services.model

Class SetObjectMetadataRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.SetObjectMetadataRequest

public class SetObjectMetadataRequest
extends BaseObjectRequest

Parameters in a request for setting object properties

Field Summary

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

objectKey

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
SetObjectMetadataRequest()
SetObjectMetadataRequest(String bucketName, String objectKey) Constructor
SetObjectMetadataRequest(String bucketName, String objectKey, String versionId) Constructor

Method Summary

Modifier and Type	Method and Description
void	addAllUserMetadata(Map<String,String> userMetadata) Add customized metadata for a group of objects.
void	addUserMetadata(String key, String value) Add customized metadata for an object.
Map<String,String>	getAllUserMetadata()
String	getCacheControl() Obtain the rewritten "Cache-Control" header in the response.
String	getContentDisposition() Obtain the rewritten "Content-Disposition" header in the response.
String	getContentEncoding() Obtain the rewritten "Content-Encoding" header in the response.
String	getContentLanguage() Obtain the rewritten "Content-Language" header in the response.
String	getContentType() Obtain the rewritten "Content-Type" header in the response.
String	getExpires() Obtain the rewritten "Expires" header in the response.
Map<String,String>	getMetadata() Deprecated.
StorageClassEnum	getObjectStorageClass() Obtain the object storage class.
Object	getUserMetadata(String key) Obtain the customized metadata of an object.
String	getVersionId() Obtain the object version ID.
String	getWebSiteRedirectLocation() Set the redirection link which can redirect the request to another object in the bucket or to an external URL.
boolean	isEncodeHeaders() Specifies whether to encode and decode the returned header fields.
boolean	isRemoveUnset() Specify whether to delete not specified properties.
void	setCacheControl(String cacheControl) Rewrite the "Cache-Control" header in the response.
void	setContentDisposition(String contentDisposition) Rewrite the "Content-Disposition" header in the response.
void	setContentEncoding(String contentEncoding) Rewrite the "Content-Encoding" header in the response.
void	setContentLanguage(String contentLanguage) Rewrite the "Content-Language" header in the response.
void	setContentType(String contentType) Rewrite the "Content-Type" header in the response.
void	setExpires(String expires) Rewrite the "Expires" header in the response.
void	setIsEncodeHeaders(boolean encodeHeaders) Specifies whether to encode and decode the returned header fields.
void	setObjectStorageClass(StorageClassEnum storageClass) Set the object storage class.
void	setRemoveUnset(boolean removeUnset) Specify whether to delete not specified properties.
void	setVersionId(String versionId) Set the version ID of the object.
void	setWebSiteRedirectLocation(String webSiteRedirectLocation) Obtain the redirection link which can redirect the request to another object in the bucket or to an external URL.
String	toString()

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

getObjectKey, setObjectKey

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

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

SetObjectMetadataRequest

public SetObjectMetadataRequest()

SetObjectMetadataRequest

public SetObjectMetadataRequest(String bucketName,
                                String objectKey)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

SetObjectMetadataRequest

public SetObjectMetadataRequest(String bucketName,
                                String objectKey,
                                String versionId)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Version ID of the object

Method Detail

getVersionId

public String getVersionId()

Obtain the object version ID.

Returns:

Version ID of the object

setVersionId

public void setVersionId(String versionId)

Set the version ID of the object.

Parameters:

versionId - Version ID of the object

getWebSiteRedirectLocation

public String getWebSiteRedirectLocation()

Set the redirection link which can redirect the request to another object in the bucket or to an external URL.

Returns:

Redirection link

setWebSiteRedirectLocation

public void setWebSiteRedirectLocation(String webSiteRedirectLocation)

Obtain the redirection link which can redirect the request to another object in the bucket or to an external URL.

Parameters:

webSiteRedirectLocation - Redirection link

getObjectStorageClass

public StorageClassEnum getObjectStorageClass()

Obtain the object storage class.

Returns:

Object storage class

setObjectStorageClass

public void setObjectStorageClass(StorageClassEnum storageClass)

Set the object storage class.

Parameters:

storageClass - Object storage class

isRemoveUnset

public boolean isRemoveUnset()

Specify whether to delete not specified properties. The default value is "false." true: Use properties set in the request parameters to overwrite the existing property values. Properties not specified in the request will be deleted. false: Use properties set in the request parameters to overwrite the existing property values. For properties not specified in the request, their existing values are retained.

Returns:

Identifier specifying whether to delete not specified properties

setRemoveUnset

public void setRemoveUnset(boolean removeUnset)

Specify whether to delete not specified properties.

Parameters:

removeUnset - Identifier specifying whether to delete not specified properties

addUserMetadata

public void addUserMetadata(String key,
                            String value)

Add customized metadata for an object.

Parameters:

key - Keyword of the customized metadata

value - Value of the customized metadata

addAllUserMetadata

public void addAllUserMetadata(Map<String,String> userMetadata)

Add customized metadata for a group of objects.

Parameters:

userMetadata - Customized metadata for a group of objects

getUserMetadata

public Object getUserMetadata(String key)

Obtain the customized metadata of an object.

Parameters:

key - Keyword of the customized metadata

Returns:

Value of the customized metadata

getContentType

public String getContentType()

Obtain the rewritten "Content-Type" header in the response.

Returns:

"Content-Type" header in the response

setContentType

public void setContentType(String contentType)

Rewrite the "Content-Type" header in the response.

Parameters:

contentType - "Content-Type" header in the response

getContentLanguage

public String getContentLanguage()

Obtain the rewritten "Content-Language" header in the response.

Returns:

"Content-Language" header in the response

setContentLanguage

public void setContentLanguage(String contentLanguage)

Rewrite the "Content-Language" header in the response.

Parameters:

contentLanguage - "Content-Language" header in the response

getExpires

public String getExpires()

Obtain the rewritten "Expires" header in the response.

Returns:

"Expires" header in the response

setExpires

public void setExpires(String expires)

Rewrite the "Expires" header in the response.

Parameters:

expires - Rewritten "Expires" header in the response

getCacheControl

public String getCacheControl()

Obtain the rewritten "Cache-Control" header in the response.

Returns:

"Cache-Control" header in the response

setCacheControl

public void setCacheControl(String cacheControl)

Rewrite the "Cache-Control" header in the response.

Parameters:

cacheControl - "Cache-Control" header in the response

getContentDisposition

public String getContentDisposition()

Obtain the rewritten "Content-Disposition" header in the response.

Returns:

"Content-Disposition" header in the response

setContentDisposition

public void setContentDisposition(String contentDisposition)

Rewrite the "Content-Disposition" header in the response.

Parameters:

contentDisposition - "Content-Disposition" header in the response

getContentEncoding

public String getContentEncoding()

Obtain the rewritten "Content-Encoding" header in the response.

Returns:

"Content-Encoding" header in the response

setContentEncoding

public void setContentEncoding(String contentEncoding)

Rewrite the "Content-Encoding" header in the response.

Parameters:

contentEncoding - "Content-Encoding" header in the response

getAllUserMetadata

public Map<String,String> getAllUserMetadata()

getMetadata

@Deprecated
public Map<String,String> getMetadata()

Deprecated.

setIsEncodeHeaders

public void setIsEncodeHeaders(boolean encodeHeaders)

Specifies whether to encode and decode the returned header fields.

Overrides:

setIsEncodeHeaders in class BaseObjectRequest

Parameters:

encodeHeaders - Specifies whether to encode and decode header fields.

isEncodeHeaders

public boolean isEncodeHeaders()

Specifies whether to encode and decode the returned header fields.

Overrides:

isEncodeHeaders in class BaseObjectRequest

Returns:

Specifies whether to encode and decode header fields.

toString

public String toString()

Overrides:

toString in class BaseObjectRequest