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

设置对象属性的请求参数

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) 构造函数
SetObjectMetadataRequest(String bucketName, String objectKey, String versionId) 构造函数

Method Summary

Modifier and Type	Method and Description
void	addAllUserMetadata(Map<String,String> userMetadata) 新增一组对象的自定义元数据
void	addUserMetadata(String key, String value) 新增对象的自定义元数据
Map<String,String>	getAllUserMetadata()
String	getCacheControl() 获取重写响应中的Cache-Control头
String	getContentDisposition() 获取重写响应中的Content-Disposition头
String	getContentEncoding() 获取重写响应中的Content-Encoding头
String	getContentLanguage() 获取重写响应中的Content-Language头
String	getContentType() 获取重写响应中的Content-Type头
String	getExpires() 获取重写响应中的Expires头
Map<String,String>	getMetadata() Deprecated.
StorageClassEnum	getObjectStorageClass() 获取对象的存储类型
Object	getUserMetadata(String key) 获取对象的自定义元数据
String	getVersionId() 获取对象版本号
String	getWebSiteRedirectLocation() 设置对象的重定向链接，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL
boolean	isEncodeHeaders() 获取是否对返回的头域的字段进行编解码
boolean	isRemoveUnset() 判断是否删除未指定属性， 默认为false true：使用当前请求中的各项参数设置对象属性，对于已经存在值的属性进行替换，不存在值的属性进行赋值，未指定的属性删除 false：使用当前请求中的各项参数设置对象属性，对于已经存在值的属性进行替换，不存在值的属性进行赋值，未指定的属性保持不变
void	setCacheControl(String cacheControl) 设置重写响应中的Cache-Control头
void	setContentDisposition(String contentDisposition) 设置重写响应中的Content-Disposition头
void	setContentEncoding(String contentEncoding) 设置重写响应中的Content-Encoding头
void	setContentLanguage(String contentLanguage) 设置重写响应中的Content-Language头
void	setContentType(String contentType) 设置重写响应中的Content-Type头
void	setExpires(String expires) 设置重写响应中的Expires头
void	setIsEncodeHeaders(boolean encodeHeaders) 设置是否对返回的头域的字段进行编解码
void	setObjectStorageClass(StorageClassEnum storageClass) 设置对象的存储类型
void	setRemoveUnset(boolean removeUnset) 设置是否删除未指定属性
void	setVersionId(String versionId) 设置对象版本号
void	setWebSiteRedirectLocation(String webSiteRedirectLocation) 获取对象的重定向链接，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的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)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

SetObjectMetadataRequest

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

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

versionId - 对象的版本号

Method Detail

getVersionId

public String getVersionId()

获取对象版本号

Returns:

对象版本号

setVersionId

public void setVersionId(String versionId)

设置对象版本号

Parameters:

versionId - 对象版本号

getWebSiteRedirectLocation

public String getWebSiteRedirectLocation()

设置对象的重定向链接，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL

Returns:

重定向链接

setWebSiteRedirectLocation

public void setWebSiteRedirectLocation(String webSiteRedirectLocation)

获取对象的重定向链接，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL

Parameters:

webSiteRedirectLocation - 重定向链接

getObjectStorageClass

public StorageClassEnum getObjectStorageClass()

获取对象的存储类型

Returns:

对象的存储类型

setObjectStorageClass

public void setObjectStorageClass(StorageClassEnum storageClass)

设置对象的存储类型

Parameters:

storageClass - 对象的存储类型

isRemoveUnset

public boolean isRemoveUnset()

判断是否删除未指定属性， 默认为false true：使用当前请求中的各项参数设置对象属性，对于已经存在值的属性进行替换，不存在值的属性进行赋值，未指定的属性删除 false：使用当前请求中的各项参数设置对象属性，对于已经存在值的属性进行替换，不存在值的属性进行赋值，未指定的属性保持不变

Returns:

是否删除未指定属性标识

setRemoveUnset

public void setRemoveUnset(boolean removeUnset)

设置是否删除未指定属性

Parameters:

removeUnset - 是否删除未指定属性标识

addUserMetadata

public void addUserMetadata(String key,
                            String value)

新增对象的自定义元数据

Parameters:

key - 自定义元数据的关键字

value - 自定义元数据的值

addAllUserMetadata

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

新增一组对象的自定义元数据

Parameters:

userMetadata - 一组对象的自定义元数据

getUserMetadata

public Object getUserMetadata(String key)

获取对象的自定义元数据

Parameters:

key - 自定义元数据的关键字

Returns:

自定义元数据的值

getContentType

public String getContentType()

获取重写响应中的Content-Type头

Returns:

响应中的Content-Type头

setContentType

public void setContentType(String contentType)

设置重写响应中的Content-Type头

Parameters:

contentType - 响应中的Content-Type头

getContentLanguage

public String getContentLanguage()

获取重写响应中的Content-Language头

Returns:

响应中的Content-Language头

setContentLanguage

public void setContentLanguage(String contentLanguage)

设置重写响应中的Content-Language头

Parameters:

contentLanguage - 响应中的Content-Language头

getExpires

public String getExpires()

获取重写响应中的Expires头

Returns:

响应中的Expires头

setExpires

public void setExpires(String expires)

设置重写响应中的Expires头

Parameters:

expires - 响应中的Expires头

getCacheControl

public String getCacheControl()

获取重写响应中的Cache-Control头

Returns:

响应中的Cache-Control头

setCacheControl

public void setCacheControl(String cacheControl)

设置重写响应中的Cache-Control头

Parameters:

cacheControl - 响应中的Cache-Control头

getContentDisposition

public String getContentDisposition()

获取重写响应中的Content-Disposition头

Returns:

响应中的Content-Disposition头

setContentDisposition

public void setContentDisposition(String contentDisposition)

设置重写响应中的Content-Disposition头

Parameters:

contentDisposition - 响应中的Content-Disposition头

getContentEncoding

public String getContentEncoding()

获取重写响应中的Content-Encoding头

Returns:

响应中的Content-Encoding头

setContentEncoding

public void setContentEncoding(String contentEncoding)

设置重写响应中的Content-Encoding头

Parameters:

contentEncoding - 响应中的Content-Encoding头

getAllUserMetadata

public Map<String,String> getAllUserMetadata()

getMetadata

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

Deprecated.

setIsEncodeHeaders

public void setIsEncodeHeaders(boolean encodeHeaders)

设置是否对返回的头域的字段进行编解码

Overrides:

setIsEncodeHeaders in class BaseObjectRequest

Parameters:

encodeHeaders - 是否对头域字段进行编解码

isEncodeHeaders

public boolean isEncodeHeaders()

获取是否对返回的头域的字段进行编解码

Overrides:

isEncodeHeaders in class BaseObjectRequest

Returns:

是否对头域字段进行编解码

toString

public String toString()

Overrides:

toString in class BaseObjectRequest