com.qcloud.cos.model

类 ObjectMetadata

java.lang.Object

com.qcloud.cos.model.ObjectMetadata

所有已实现的接口:

ObjectExpirationResult, ObjectRestoreResult, Cloneable

public class ObjectMetadata
extends Object
implements ObjectExpirationResult, ObjectRestoreResult, Cloneable

Represents the object metadata that is stored with Qcloud COS. This includes custom user-supplied metadata, as well as the standard HTTP headers that Qcloud COS sends and receives (Content-Length, ETag, Content-MD5, etc.).

构造器概要

构造器

构造器和说明
ObjectMetadata()

方法概要

方法

限定符和类型	方法和说明
void	addUserMetadata(String key, String value) Adds the key value pair of custom user-metadata for the associated object.
ObjectMetadata	clone()
String	getCacheControl() Gets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.
String	getContentDisposition() Gets the optional Content-Disposition HTTP header, which specifies presentation information for the object such as the recommended filename for the object to be saved as.
String	getContentEncoding() Gets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.
String	getContentLanguage() Gets the Content-Language HTTP header, which describes the natural language(s) of the intended audience for the enclosed entity.
long	getContentLength() Gets the Content-Length HTTP header indicating the size of the associated object in bytes.
String	getContentMD5() Gets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
String	getContentType() Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object.
String	getETag() Gets the hex encoded 128-bit MD5 digest of the associated object according to RFC 1864.
Date	getExpirationTime() Returns the time this object will expire and be completely removed from COS.
String	getExpirationTimeRuleId() Returns the BucketLifecycleConfiguration rule ID for this object's expiration, or null if it doesn't expire.
Date	getHttpExpiresDate() Returns the date when the object is no longer cacheable.
Date	getLastModified() Gets the value of the Last-Modified header, indicating the date and time at which Qcloud COS last recorded a modification to the associated object.
Boolean	getOngoingRestore() Returns the boolean value which indicates whether there is ongoing restore request.
Map<String,Object>	getRawMetadata() For internal use only.
Object	getRawMetadataValue(String key) For internal use only.
Date	getRestoreExpirationTime() Returns the time at which an object that has been temporarily restored from CAS will expire, and will need to be restored again in order to be accessed.
String	getServerSideEncryption() Returns the server-side encryption algorithm for the object, or null if none was used.
Map<String,String>	getUserMetadata() Gets the custom user-metadata for the associated object.
String	getUserMetaDataOf(String key) Returns the value of the specified user meta datum.
String	getVersionId() Gets the version ID of the associated Qcloud COS object if available.
boolean	isDeleteMarker()
void	setCacheControl(String cacheControl) Sets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.
void	setContentDisposition(String disposition) Sets the optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.
void	setContentEncoding(String encoding) Sets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.
void	setContentLanguage(String contentLanguage) Sets the Content-Language HTTP header which describes the natural language(s) of the intended audience for the enclosed entity.
void	setContentLength(long contentLength) Sets the Content-Length HTTP header indicating the size of the associated object in bytes.
void	setContentMD5(String md5Base64) Sets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
void	setContentType(String contentType) Sets the Content-Type HTTP header indicating the type of content stored in the associated object.
void	setDeleteMarker(boolean isDeleteMarker)
void	setExpirationTime(Date expirationTime) For internal use only.
void	setExpirationTimeRuleId(String expirationTimeRuleId) Sets the BucketLifecycleConfiguration rule ID for this object's expiration
void	setHeader(String key, Object value) For internal use only.
void	setHttpExpiresDate(Date httpExpiresDate) Set the date when the object is no longer cacheable.
void	setLastModified(Date lastModified) For internal use only.
void	setOngoingRestore(boolean ongoingRestore) For internal use only.
void	setRestoreExpirationTime(Date restoreExpirationTime) only used to set the value in the object after receiving the value in a response from COS.
void	setSecurityToken(String securityToken) Sets the security token for the object.
void	setServerSideEncryption(String serverSideEncryption) Sets the server-side encryption algorithm for the object.
void	setUserMetadata(Map<String,String> userMetadata) Sets the custom user-metadata for the associated object.

从类继承的方法 java.lang.Object

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

构造器详细资料

ObjectMetadata

public ObjectMetadata()

方法详细资料

getUserMetadata

public Map<String,String> getUserMetadata()

Gets the custom user-metadata for the associated object.

Qcloud COS can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-cos-meta-". Use user-metadata to store arbitrary metadata alongside their data in Qcloud COS. When setting user metadata, callers should not include the internal "x-cos-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-cos-meta-" header prefix.

User-metadata keys are case insensitive and will be returned as lowercase strings, even if they were originally specified with uppercase strings.

Note that user-metadata for an object is limited by the HTTP request header limit. All HTTP headers included in a request (including user metadata headers and other standard HTTP headers) must be less than 8KB.

返回:

The custom user metadata for the associated object.

另请参阅:

setUserMetadata(Map), addUserMetadata(String, String)

setUserMetadata

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

Sets the custom user-metadata for the associated object.

Qcloud COS can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-cos-meta-". Use user-metadata to store arbitrary metadata alongside their data in Qcloud COS. When setting user metadata, callers should not include the internal "x-cos-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-cos-meta-" header prefix.

User-metadata keys are case insensitive and will be returned as lowercase strings, even if they were originally specified with uppercase strings.

Note that user-metadata for an object is limited by the HTTP request header limit. All HTTP headers included in a request (including user metadata headers and other standard HTTP headers) must be less than 8KB.

参数:

userMetadata - The custom user-metadata for the associated object. Note that the key should not include the internal COS HTTP header prefix.

另请参阅:

getUserMetadata(), addUserMetadata(String, String)

setHeader

public void setHeader(String key,
             Object value)

For internal use only. Sets a specific metadata header value. Not intended to be called by external code.

参数:

key - The name of the header being set.

value - The value for the header.

addUserMetadata

public void addUserMetadata(String key,
                   String value)

Adds the key value pair of custom user-metadata for the associated object. If the entry in the custom user-metadata map already contains the specified key, it will be replaced with these new contents.

Qcloud COS can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-cos-meta-". Use user-metadata to store arbitrary metadata alongside their data in Qcloud COS. When setting user metadata, callers should not include the internal "x-cos-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-cos-meta-" header prefix.

Note that user-metadata for an object is limited by the HTTP request header limit. All HTTP headers included in a request (including user metadata headers and other standard HTTP headers) must be less than 8KB.

参数:

key - The key for the custom user metadata entry. Note that the key should not include the internal COS HTTP header prefix.

value - The value for the custom user-metadata entry.

另请参阅:

setUserMetadata(Map), getUserMetadata()

getRawMetadata

public Map<String,Object> getRawMetadata()

For internal use only. Gets a map of the raw metadata/headers for the associated object.

返回:

A map of the raw metadata/headers for the associated object.

getRawMetadataValue

public Object getRawMetadataValue(String key)

For internal use only. Returns the raw value of the metadata/headers for the specified key.

getLastModified

public Date getLastModified()

Gets the value of the Last-Modified header, indicating the date and time at which Qcloud COS last recorded a modification to the associated object.

返回:

The date and time at which Qcloud COS last recorded a modification to the associated object. Returns null if the Last-Modified header hasn't been set.

setLastModified

public void setLastModified(Date lastModified)

For internal use only. Sets the Last-Modified header value indicating the date and time at which Qcloud COS last recorded a modification to the associated object.

参数:

lastModified - The date and time at which Qcloud COS last recorded a modification to the associated object.

getContentLength

public long getContentLength()

Gets the Content-Length HTTP header indicating the size of the associated object in bytes.

This field is required when uploading objects to COS, but the COS Java client will automatically set it when working directly with files. When uploading directly from a stream, set this field if possible. Otherwise the client must buffer the entire stream in order to calculate the content length before sending the data to Qcloud COS.

For more information on the Content-Length HTTP header, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.13

返回:

The Content-Length HTTP header indicating the size of the associated object in bytes. Returns null if it hasn't been set yet.

另请参阅:

setContentLength(long)

setContentLength

public void setContentLength(long contentLength)

Sets the Content-Length HTTP header indicating the size of the associated object in bytes.

This field is required when uploading objects to COS, but the COS Java client will automatically set it when working directly with files. When uploading directly from a stream, set this field if possible. Otherwise the client must buffer the entire stream in order to calculate the content length before sending the data to Qcloud COS.

For more information on the Content-Length HTTP header, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.13

参数:

contentLength - The Content-Length HTTP header indicating the size of the associated object in bytes.

另请参阅:

getContentLength()

getContentType

public String getContentType()

Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.

When uploading files, the COS Java client will attempt to determine the correct content type if one hasn't been set yet. Users are responsible for ensuring a suitable content type is set when uploading streams. If no content type is provided and cannot be determined by the filename, the default content type, "application/octet-stream", will be used.

For more information on the Content-Type header, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.17

返回:

The HTTP Content-Type header, indicating the type of content stored in the associated object. Returns null if it hasn't been set.

另请参阅:

setContentType(String)

setContentType

public void setContentType(String contentType)

Sets the Content-Type HTTP header indicating the type of content stored in the associated object. The value of this header is a standard MIME type.

When uploading files, the COS Java client will attempt to determine the correct content type if one hasn't been set yet. Users are responsible for ensuring a suitable content type is set when uploading streams. If no content type is provided and cannot be determined by the filename, the default content type "application/octet-stream" will be used.

For more information on the Content-Type header, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.17

参数:

contentType - The HTTP Content-Type header indicating the type of content stored in the associated COS object.

另请参阅:

getContentType()

getContentLanguage

public String getContentLanguage()

Gets the Content-Language HTTP header, which describes the natural language(s) of the intended audience for the enclosed entity.

setContentLanguage

public void setContentLanguage(String contentLanguage)

Sets the Content-Language HTTP header which describes the natural language(s) of the intended audience for the enclosed entity.

getContentEncoding

public String getContentEncoding()

Gets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.

For more information on how the Content-Encoding HTTP header works, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.11

返回:

The HTTP Content-Encoding header. Returns null if it hasn't been set.

另请参阅:

setContentType(String)

setContentEncoding

public void setContentEncoding(String encoding)

Sets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.

For more information on how the Content-Encoding HTTP header works, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.11

参数:

encoding - The HTTP Content-Encoding header, as defined in RFC 2616.

另请参阅:

http://www.w3 .org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11, getContentType()

getCacheControl

public String getCacheControl()

Gets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.

For more information on how the Cache-Control HTTP header affects HTTP requests and responses, see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.9

返回:

The HTTP Cache-Control header as defined in RFC 2616. Returns null if it hasn't been set.

另请参阅:

setCacheControl(String)

setCacheControl

public void setCacheControl(String cacheControl)

Sets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.

For more information on how the Cache-Control HTTP header affects HTTP requests and responses see http://www.w3.org/ Protocols/rfc2616/rfc2616-sec14.html#sec14.9

参数:

cacheControl - The HTTP Cache-Control header as defined in RFC 2616.

另请参阅:

getCacheControl()

setContentMD5

public void setContentMD5(String md5Base64)

Sets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Qcloud COS is the same data that the caller sent. If set to null,then the MD5 digest is removed from the metadata.

This field represents the base64 encoded 128-bit MD5 digest digest of an object's content as calculated on the caller's side. The ETag metadata field represents the hex encoded 128-bit MD5 digest as computed by Qcloud COS.

The COS Java client will attempt to calculate this field automatically when uploading files to Qcloud COS.

参数:

md5Base64 - The base64 encoded MD5 hash of the content for the object associated with this metadata.

另请参阅:

getContentMD5()

getContentMD5

public String getContentMD5()

Gets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Qcloud COS is the same data that the caller sent.

This field represents the base64 encoded 128-bit MD5 digest digest of an object's content as calculated on the caller's side. The ETag metadata field represents the hex encoded 128-bit MD5 digest as computed by Qcloud COS.

The COS Java client will attempt to calculate this field automatically when uploading files to Qcloud COS.

返回:

The base64 encoded MD5 hash of the content for the associated object. Returns null if the MD5 hash of the content hasn't been set.

另请参阅:

setContentMD5(String)

setContentDisposition

public void setContentDisposition(String disposition)

Sets the optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.

For more information on how the Content-Disposition header affects HTTP client behavior, see http://www.w3.org /Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

参数:

disposition - The value for the Content-Disposition header.

另请参阅:

getContentDisposition()

getContentDisposition

public String getContentDisposition()

Gets the optional Content-Disposition HTTP header, which specifies presentation information for the object such as the recommended filename for the object to be saved as.

For more information on how the Content-Disposition header affects HTTP client behavior, see http://www.w3.org /Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

返回:

The value of the Content-Disposition header. Returns null if the Content-Disposition header hasn't been set.

另请参阅:

http://www. w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1, setCacheControl(String)

getETag

public String getETag()

Gets the hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Qcloud COS.

This field represents the hex encoded 128-bit MD5 digest of an object's content as calculated by Qcloud COS. The ContentMD5 field represents the base64 encoded 128-bit MD5 digest as calculated on the caller's side.

返回:

The hex encoded MD5 hash of the content for the associated object as calculated by Qcloud COS. Returns null if it hasn't been set yet.

getVersionId

public String getVersionId()

Gets the version ID of the associated Qcloud COS object if available. Version IDs are only assigned to objects when an object is uploaded to an Qcloud COS bucket that has object versioning enabled.

返回:

The version ID of the associated Qcloud COS object if available.

getServerSideEncryption

public String getServerSideEncryption()

Returns the server-side encryption algorithm for the object, or null if none was used.

setServerSideEncryption

public void setServerSideEncryption(String serverSideEncryption)

Sets the server-side encryption algorithm for the object.

参数:

serverSideEncryption - The server-side encryption algorithm for the object.

setSecurityToken

public void setSecurityToken(String securityToken)

Sets the security token for the object.

参数:

securityToken - The security token for the object.

getExpirationTime

public Date getExpirationTime()

Returns the time this object will expire and be completely removed from COS. Returns null if this object will never expire.

指定者:

getExpirationTime 在接口中 ObjectExpirationResult

setExpirationTime

public void setExpirationTime(Date expirationTime)

For internal use only. This will *not* set the object's expiration time, and is only used to set the value in the object after receiving the value in a response from COS.

指定者:

setExpirationTime 在接口中 ObjectExpirationResult

参数:

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.

指定者:

getExpirationTimeRuleId 在接口中 ObjectExpirationResult

另请参阅:

Rule#getId()

setExpirationTimeRuleId

public void setExpirationTimeRuleId(String expirationTimeRuleId)

Sets the BucketLifecycleConfiguration rule ID for this object's expiration

指定者:

setExpirationTimeRuleId 在接口中 ObjectExpirationResult

参数:

expirationTimeRuleId - The rule ID for this object's expiration

setHttpExpiresDate

public void setHttpExpiresDate(Date httpExpiresDate)

Set the date when the object is no longer cacheable.

getHttpExpiresDate

public Date getHttpExpiresDate()

Returns the date when the object is no longer cacheable.

getRestoreExpirationTime

public Date getRestoreExpirationTime()

Returns the time at which an object that has been temporarily restored from CAS will expire, and will need to be restored again in order to be accessed. Returns null if this is not a temporary copy of an object restored from CAS.

指定者:

getRestoreExpirationTime 在接口中 ObjectRestoreResult

setRestoreExpirationTime

public void setRestoreExpirationTime(Date restoreExpirationTime)

only used to set the value in the object after receiving the value in a response from COS.

指定者:

setRestoreExpirationTime 在接口中 ObjectRestoreResult

参数:

restoreExpirationTime - The new restore expiration time for the object.

setOngoingRestore

public void setOngoingRestore(boolean ongoingRestore)

For internal use only. Sets the boolean value which indicates whether there is ongoing restore request. Not intended to be called by external code.

指定者:

setOngoingRestore 在接口中 ObjectRestoreResult

getOngoingRestore

public Boolean getOngoingRestore()

Returns the boolean value which indicates whether there is ongoing restore request.

指定者:

getOngoingRestore 在接口中 ObjectRestoreResult

isDeleteMarker

public boolean isDeleteMarker()

setDeleteMarker

public void setDeleteMarker(boolean isDeleteMarker)

getUserMetaDataOf

public String getUserMetaDataOf(String key)

Returns the value of the specified user meta datum.

clone

public ObjectMetadata clone()

覆盖:

clone 在类中 Object