com.netease.cloud.services.nos.model
public class ObjectMetadata extends Object implements ObjectExpirationResult
Modifier and Type | Field and Description |
---|---|
static String |
AES_256_SERVER_SIDE_ENCRYPTION |
Constructor and Description |
---|
ObjectMetadata() |
Modifier and Type | Method and Description |
---|---|
void |
addUserMetadata(String key,
String value)
Adds the key value pair of custom user-metadata for the associated
object.
|
String |
getCallbackRet() |
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 expiration time for this object, or null if it doesn't
expire.
|
String |
getExpirationTimeRuleId()
object's expiration, or null if it doesn't expire.
|
Date |
getLastModified()
Gets the value of the Last-Modified header, indicating the date and time
at which Nos last recorded a modification to the associated object.
|
String |
getObjectName() |
Map<String,Object> |
getRawMetadata()
For internal use only.
|
Map<String,String> |
getUserMetadata()
Gets the custom user-metadata for the associated object.
|
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 |
setExpirationTime(Date expirationTime)
Sets the expiration time for the object.
|
void |
setExpirationTimeRuleId(String expirationTimeRuleId)
expiration
|
void |
setHeader(String key,
Object value)
For internal use only.
|
void |
setLastModified(Date lastModified)
For internal use only.
|
void |
setUserMetadata(Map<String,String> userMetadata)
Sets the custom user-metadata for the associated object.
|
public static final String AES_256_SERVER_SIDE_ENCRYPTION
public Map<String,String> getUserMetadata()
Gets the custom user-metadata for the associated object.
Nos can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-amz-meta-". Use user-metadata to store arbitrary metadata alongside their data in Nos. When setting user metadata, callers should not include the internal "x-amz-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-amz-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.
setUserMetadata(Map)
,
addUserMetadata(String, String)
public void setUserMetadata(Map<String,String> userMetadata)
Sets the custom user-metadata for the associated object.
Nos can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-amz-meta-". Use user-metadata to store arbitrary metadata alongside their data in Nos. When setting user metadata, callers should not include the internal "x-amz-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-amz-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 Nos HTTP header
prefix.getUserMetadata()
,
addUserMetadata(String, String)
public void setHeader(String key, Object value)
key
- The name of the header being set.value
- The value for the header.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.
Nos can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-amz-meta-". Use user-metadata to store arbitrary metadata alongside their data in Nos. When setting user metadata, callers should not include the internal "x-amz-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-amz-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 Nos HTTP header prefix.value
- The value for the custom user-metadata entry.setUserMetadata(Map)
,
getUserMetadata()
public Map<String,Object> getRawMetadata()
public Date getLastModified()
null
if the
Last-Modified header hasn't been set.public void setLastModified(Date lastModified)
lastModified
- The date and time at which Nos last recorded a modification to
the associated object.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 Nos, but the Nos 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 Nos.
For more information on the Content-Length HTTP header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
null
if it
hasn't been set yet.setContentLength(long)
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 Nos, but the Nos 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 Nos.
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()
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 Nos 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
null
if
it hasn't been set.setContentType(String)
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 Nos 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 Nos object.getContentType()
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 Nos 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 Nos.
The Nos Java client will attempt to calculate this field automatically when uploading files to Nos.
md5Base64
- The base64 encoded MD5 hash of the content for the object
associated with this metadata.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 Nos 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 Nos.
The Nos Java client will attempt to calculate this field automatically when uploading files to Nos.
null
if the MD5 hash of the content
hasn't been set.setContentMD5(String)
public String getETag()
This field represents the hex encoded 128-bit MD5 digest of an object's content as calculated by Nos. The ContentMD5 field represents the base64 encoded 128-bit MD5 digest as calculated on the caller's side.
null
if it hasn't been
set yet.public String getObjectName()
public String getCallbackRet()
public Date getExpirationTime()
getExpirationTime
in interface ObjectExpirationResult
public void setExpirationTime(Date expirationTime)
setExpirationTime
in interface ObjectExpirationResult
expirationTime
- The expiration time for the object.public String getExpirationTimeRuleId()
getExpirationTimeRuleId
in interface ObjectExpirationResult
public void setExpirationTimeRuleId(String expirationTimeRuleId)
setExpirationTimeRuleId
in interface ObjectExpirationResult
expirationTimeRuleId
- The rule ID for this object's expirationCopyright © 2017. All Rights Reserved.