ObjectMetadata (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.services.s3.model.ObjectMetadata

All Implemented Interfaces:

ObjectExpirationResult, ObjectRestoreResult, ObjectTransitionResult, S3RequesterChargedResult, ServerSideEncryptionResult, Serializable, Cloneable
```
public class ObjectMetadata
extends Object
implements ServerSideEncryptionResult, S3RequesterChargedResult, ObjectExpirationResult, ObjectRestoreResult, ObjectTransitionResult, Cloneable, Serializable
```
Represents the object metadata that is stored with Amazon S3. This includes custom user-supplied metadata, as well as the standard HTTP headers that Amazon S3 sends and receives (Content-Length, ETag, Content-MD5, etc.).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String AES_256_SERVER_SIDE_ENCRYPTION

Fields
Modifier and Type	Field and Description
`static String`	`AES_256_SERVER_SIDE_ENCRYPTION`

Constructor Summary

Constructors
Constructor and Description

ObjectMetadata()

Constructors
Constructor and Description
`ObjectMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.
`ObjectMetadata`	`clone()` Returns a clone of this `ObjectMetadata`.
`String`	`getArchiveStatus()`
`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.
`Long[]`	`getContentRange()` Returns the content range of the object if response contains the Content-Range header.
`String`	`getContentType()` Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object.
`String`	`getETag()` The entity tag is a hash of the object.
`Date`	`getExpirationTime()` Returns the time this object will expire and be completely removed from S3.
`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.
`String`	`getIbmRestoredCopyStorageClass()`
`String`	`getIbmTransition()`
`long`	`getInstanceLength()` Returns the physical length of the entire object stored in S3.
`Date`	`getLastModified()` Gets the value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.
`String`	`getObjectLockLegalHoldStatus()` The Legal Hold status of the specified object.
`String`	`getObjectLockMode()` The Object Lock mode applied to this object.
`Date`	`getObjectLockRetainUntilDate()` The date and time this object's Object Lock will expire.
`Boolean`	`getOngoingRestore()` Returns the boolean value which indicates whether there is ongoing restore request.
`Integer`	`getPartCount()` Returns the value of x-amz-mp-parts-count header.
`Map<String,Object>`	`getRawMetadata()` Gets a map of the raw metadata/headers for the associated object.
`Object`	`getRawMetadataValue(String key)` Returns the raw value of the metadata/headers for the specified key.
`String`	`getReplicationStatus()`
`Date`	`getRestoreExpirationTime()` Returns the time at which an object that has been temporarily restored from Amazon Glacier will expire, and will need to be restored again in order to be accessed.
`Date`	`getRetentionExpirationDate()`
`Integer`	`getRetentionLegalHoldCount()`
`Long`	`getRetentionPeriod()`
`String`	`getServerSideEncryption()` Deprecated. Replaced by `ObjectMetadata.getSSEAlgorithm()`
`String`	`getSSEAlgorithm()` Returns the server-side encryption algorithm when encrypting the object using Amazon Web Services-managed keys .
`String`	`getSSECustomerAlgorithm()` Returns the server-side encryption algorithm if the object is encrypted using customer-provided keys.
`String`	`getSSECustomerKeyMd5()` Returns the base64-encoded MD5 digest of the encryption key for server-side encryption, if the object is encrypted using customer-provided keys.
`String`	`getStorageClass()`
`String`	`getTransition()` Returns the transition storage class.
`Date`	`getTransitionDate()` Returns the date at which an object will be transitioned to archive storage.
`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 Amazon S3 object if available.
`boolean`	`isRequesterCharged()` Returns the AWS Key Management System encryption context used for Server Side Encryption of the Amazon S3 object.
`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`	`setExpirationTime(Date expirationTime)` For internal use only.
`void`	`setExpirationTimeRuleId(String expirationTimeRuleId)` For internal use only.
`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`	`setRequesterCharged(boolean isRequesterCharged)` Used for conducting this operation from a Requester Pays Bucket.
`void`	`setRestoreExpirationTime(Date restoreExpirationTime)` For internal use only.
`void`	`setRetentionExpirationDate(Date retentionExpirationDate)`
`void`	`setRetentionLegalHoldCount(Integer retentionLegalHoldCount)`
`void`	`setRetentionPeriod(Long retentionPeriod)`
`void`	`setServerSideEncryption(String algorithm)` Deprecated. Replaced by `ObjectMetadata.setSSEAlgorithm(String)`
`void`	`setSSEAlgorithm(String algorithm)` Sets the server-side encryption algorithm when encrypting the object using Amazon Web Services-managed keys.
`void`	`setSSECustomerAlgorithm(String algorithm)` For internal use only.
`void`	`setSSECustomerKeyMd5(String md5Digest)` For internal use only.
`void`	`setTransition(String transition)` For internal use only.
`void`	`setTransitionDate(Date transitionDate)` For internal use only.
`void`	`setUserMetadata(Map<String,String> userMetadata)` Sets the custom user-metadata for the associated object.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AES_256_SERVER_SIDE_ENCRYPTION
```
public static final String AES_256_SERVER_SIDE_ENCRYPTION
```
- Constructor Detail
  - ObjectMetadata
```
public ObjectMetadata()
```
- Method Detail
  - getUserMetadata
```
public Map<String,String> getUserMetadata()
```
    Gets the custom user-metadata for the associated object.
    
    Amazon S3 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 Amazon S3. 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.
    
    Returns:
    
    The custom user metadata for the associated object.
    
    See Also:
    
    ObjectMetadata.setUserMetadata(Map), ObjectMetadata.addUserMetadata(String, String)
  - setUserMetadata
```
public void setUserMetadata(Map<String,String> userMetadata)
```
    Sets the custom user-metadata for the associated object.
    
    Amazon S3 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 Amazon S3. 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.
    
    Parameters:
    
    userMetadata - The custom user-metadata for the associated object. Note that the key should not include the internal S3 HTTP header prefix.
    
    See Also:
    
    ObjectMetadata.getUserMetadata(), ObjectMetadata.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.
    
    Parameters:
    
    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.
    
    Amazon S3 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 Amazon S3. 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.
    
    Parameters:
    
    key - The key for the custom user metadata entry. Note that the key should not include the internal S3 HTTP header prefix.
    
    value - The value for the custom user-metadata entry.
    
    See Also:
    
    ObjectMetadata.setUserMetadata(Map), ObjectMetadata.getUserMetadata()
  - getRawMetadata
```
public Map<String,Object> getRawMetadata()
```
    Gets a map of the raw metadata/headers for the associated object.
    
    Returns:
    
    A map of the raw metadata/headers for the associated object.
  - getRawMetadataValue
```
public Object getRawMetadataValue(String key)
```
    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 Amazon S3 last recorded a modification to the associated object.
    
    Returns:
    
    The date and time at which Amazon S3 last recorded a modification to the associated object.
  - setLastModified
```
public void setLastModified(Date lastModified)
```
    For internal use only. Sets the Last-Modified header value indicating the date and time at which Amazon S3 last recorded a modification to the associated object.
    
    Parameters:
    
    lastModified - The date and time at which Amazon S3 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 S3, but the Amazon Web Services S3 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 Amazon S3.
    
    For more information on the Content-Length HTTP header, see https://www.rfc-editor.org/rfc/rfc9110.html#section-8.6
    
    Returns:
    
    The Content-Length HTTP header indicating the size of the associated object in bytes. Returns null if it hasn't been set yet.
    
    See Also:
    
    ObjectMetadata.setContentLength(long)
  - getInstanceLength
```
public long getInstanceLength()
```
    Returns the physical length of the entire object stored in S3. This is useful during, for example, a range get operation.
  - 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 S3, but the Amazon Web Services S3 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 Amazon S3.
    
    For more information on the Content-Length HTTP header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
    
    Parameters:
    
    contentLength - The Content-Length HTTP header indicating the size of the associated object in bytes.
    
    See Also:
    
    ObjectMetadata.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 Amazon Web Services S3 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 https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
    
    Returns:
    
    The HTTP Content-Type header, indicating the type of content stored in the associated S3 object. Returns null if it hasn't been set.
    
    See Also:
    
    ObjectMetadata.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 Amazon Web Services S3 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 https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
    
    Parameters:
    
    contentType - The HTTP Content-Type header indicating the type of content stored in the associated S3 object.
    
    See Also:
    
    ObjectMetadata.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.
    
    For more information on the Content-Type header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
    
    Returns:
    
    The HTTP Content-Language header, which describes the natural language(s) of the intended audience for the enclosed entity. Returns null if it hasn't been set.
    
    See Also:
    
    ObjectMetadata.setContentLanguage(String)
  - 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.
    
    For more information on the Content-Type header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
    
    Parameters:
    
    contentLanguage - The HTTP Content-Language header which describes the natural language(s) of the intended audience for the enclosed entity.
    
    See Also:
    
    ObjectMetadata.getContentLanguage()
  - 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 https://www.rfc-editor.org/rfc/rfc9110.html#name-content-encoding
    
    Returns:
    
    The HTTP Content-Encoding header. Returns null if it hasn't been set.
    
    See Also:
    
    ObjectMetadata.setContentEncoding(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 https://www.rfc-editor.org/rfc/rfc9110.html#name-content-encoding
    
    Parameters:
    
    encoding - The HTTP Content-Encoding header, as defined in RFC 2616.
    
    See Also:
    
    https://www.rfc-editor.org/rfc/rfc9110.html#name-content-encoding, ObjectMetadata.getContentEncoding()
  - 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 https://www.rfc-editor.org/rfc/rfc9111#name-cache-control
    
    Returns:
    
    The HTTP Cache-Control header as defined in RFC 2616. Returns null if it hasn't been set.
    
    See Also:
    
    ObjectMetadata.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 https://www.rfc-editor.org/rfc/rfc9111#name-cache-control
    
    Parameters:
    
    cacheControl - The HTTP Cache-Control header as defined in RFC 2616.
    
    See Also:
    
    ObjectMetadata.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 Amazon S3 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 sometimes (but not always) represents the hex encoded 128-bit MD5 digest as computed by Amazon S3. See the documentation at ObjectMetadata.getETag() for more information on what the ETag field represents.
    
    The Amazon Web Services S3 Java client will attempt to calculate this field automatically when uploading files to Amazon S3.
    
    Parameters:
    
    md5Base64 - The base64 encoded MD5 hash of the content for the object associated with this metadata.
    
    See Also:
    
    ObjectMetadata.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 Amazon S3 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 sometimes (but not always) represents the hex encoded 128-bit MD5 digest as computed by Amazon S3. See the documentation at ObjectMetadata.getETag() for more information on what the ETag field represents.
    
    The Amazon Web Services S3 Java client will attempt to calculate this field automatically when uploading files to Amazon S3.
    
    Returns:
    
    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.
    
    See Also:
    
    ObjectMetadata.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 https://www.rfc-editor.org/rfc/rfc2616.html#section-19.5.1
    
    Parameters:
    
    disposition - The value for the Content-Disposition header.
    
    See Also:
    
    ObjectMetadata.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 https://www.rfc-editor.org/rfc/rfc2616.html#section-19.5.1
    
    Returns:
    
    The value of the Content-Disposition header. Returns null if the Content-Disposition header hasn't been set.
    
    See Also:
    
    https://www.rfc-editor.org/rfc/rfc2616.html#section-19.5.1, ObjectMetadata.setCacheControl(String)
  - getETag
```
public String getETag()
```
    The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:
    - Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
    - Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
    - If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
    Returns:
    
    The ETag of the object or nullif it hasn't been set yet.
  - getVersionId
```
public String getVersionId()
```
    Gets the version ID of the associated Amazon S3 object if available. Version IDs are only assigned to objects when an object is uploaded to an Amazon S3 bucket that has object versioning enabled.
    
    Returns:
    
    The version ID of the associated Amazon S3 object if available.
  - getSSEAlgorithm
```
public String getSSEAlgorithm()
```
    Returns the server-side encryption algorithm when encrypting the object using Amazon Web Services-managed keys .
    
    Specified by:
    
    getSSEAlgorithm in interface ServerSideEncryptionResult
  - getServerSideEncryption
```
@Deprecated
public String getServerSideEncryption()
```
    Deprecated. Replaced by ObjectMetadata.getSSEAlgorithm()
  - setSSEAlgorithm
```
public void setSSEAlgorithm(String algorithm)
```
    Sets the server-side encryption algorithm when encrypting the object using Amazon Web Services-managed keys.
    
    Specified by:
    
    setSSEAlgorithm in interface ServerSideEncryptionResult
    
    Parameters:
    
    algorithm - The server-side encryption algorithm when encrypting the object using Amazon Web Services-managed keys .
  - setServerSideEncryption
```
@Deprecated
public void setServerSideEncryption(String algorithm)
```
    Deprecated. Replaced by ObjectMetadata.setSSEAlgorithm(String)
  - getSSECustomerAlgorithm
```
public String getSSECustomerAlgorithm()
```
    Returns the server-side encryption algorithm if the object is encrypted using customer-provided keys. Otherwise returns null.
    
    Specified by:
    
    getSSECustomerAlgorithm in interface ServerSideEncryptionResult
  - setSSECustomerAlgorithm
```
public void setSSECustomerAlgorithm(String algorithm)
```
    For internal use only. This method is only used to set the value in the object after receiving the value in a response from S3. When sending requests, use SSECustomerKey members in request objects.
    
    Specified by:
    
    setSSECustomerAlgorithm in interface ServerSideEncryptionResult
    
    Parameters:
    
    algorithm - The server-side encryption algorithm used when encrypting the object with customer-provided keys.
  - getSSECustomerKeyMd5
```
public String getSSECustomerKeyMd5()
```
    Returns the base64-encoded MD5 digest of the encryption key for server-side encryption, if the object is encrypted using customer-provided keys. Otherwise returns null.
    
    Specified by:
    
    getSSECustomerKeyMd5 in interface ServerSideEncryptionResult
  - setSSECustomerKeyMd5
```
public void setSSECustomerKeyMd5(String md5Digest)
```
    For internal use only. This method is only used to set the value in the object after receiving the value in a response from S3. When sending requests, use SSECustomerKey members in request objects.
    
    Specified by:
    
    setSSECustomerKeyMd5 in interface ServerSideEncryptionResult
    
    Parameters:
    
    md5Digest - The base64-encoded MD5 digest of the encryption key for server-side encryption.
  - getIbmTransition
```
public String getIbmTransition()
```
  - getIbmRestoredCopyStorageClass
```
public String getIbmRestoredCopyStorageClass()
```
  - getExpirationTime
```
public Date getExpirationTime()
```
    Returns the time this object will expire and be completely removed from S3. Returns null if this object will never expire.
    
    Specified by:
    
    getExpirationTime in interface 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 S3.
    
    Specified by:
    
    setExpirationTime in interface ObjectExpirationResult
    
    Parameters:
    
    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.
    
    Specified by:
    
    getExpirationTimeRuleId in interface ObjectExpirationResult
    
    See Also:
    
    BucketLifecycleConfiguration.Rule.getId()
  - setExpirationTimeRuleId
```
public void setExpirationTimeRuleId(String expirationTimeRuleId)
```
    For internal use only. This will *not* set the object's expiration time rule id, and is only used to set the value in the object after receiving the value in a response from S3.
    
    Specified by:
    
    setExpirationTimeRuleId in interface ObjectExpirationResult
    
    Parameters:
    
    expirationTimeRuleId - The rule ID of this object's expiration configuration
  - getRestoreExpirationTime
```
public Date getRestoreExpirationTime()
```
    Returns the time at which an object that has been temporarily restored from Amazon Glacier 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 Glacier.
    
    Specified by:
    
    getRestoreExpirationTime in interface ObjectRestoreResult
  - setRestoreExpirationTime
```
public void setRestoreExpirationTime(Date restoreExpirationTime)
```
    For internal use only. This will *not* set the object's restore expiration time, and is only used to set the value in the object after receiving the value in a response from S3.
    
    Specified by:
    
    setRestoreExpirationTime in interface ObjectRestoreResult
    
    Parameters:
    
    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.
    
    Specified by:
    
    setOngoingRestore in interface ObjectRestoreResult
  - getOngoingRestore
```
public Boolean getOngoingRestore()
```
    Returns the boolean value which indicates whether there is ongoing restore request.
    
    Specified by:
    
    getOngoingRestore in interface ObjectRestoreResult
  - getTransitionDate
```
public Date getTransitionDate()
```
    Returns the date at which an object will be transitioned to archive storage.
    
    Specified by:
    
    getTransitionDate in interface ObjectTransitionResult
  - setTransitionDate
```
public void setTransitionDate(Date transitionDate)
```
    For internal use only. This will *not* set the object's transition date, and is only used to set the value in the object after receiving the value in a response from S3.
    
    Specified by:
    
    setTransitionDate in interface ObjectTransitionResult
    
    Parameters:
    
    transitionDate - The transition date for the object.
  - setTransition
```
public void setTransition(String transition)
```
    For internal use only. Sets the transition storage class. Not intended to be called by external code.
    
    Specified by:
    
    setTransition in interface ObjectTransitionResult
  - getTransition
```
public String getTransition()
```
    Returns the transition storage class.
    
    Specified by:
    
    getTransition in interface ObjectTransitionResult
  - 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.
  - getStorageClass
```
public String getStorageClass()
```
    Returns:
    
    The storage class of the object. Returns null if the object is in STANDARD storage. See StorageClass for possible values
  - getArchiveStatus
```
public String getArchiveStatus()
```
    Returns:
    
    The archive status for the object. Returns null if the object is not archived.
  - getUserMetaDataOf
```
public String getUserMetaDataOf(String key)
```
    Returns the value of the specified user meta datum.
  - clone
```
public ObjectMetadata clone()
```
    Returns a clone of this ObjectMetadata. Note the clone of the internal ObjectMetadata.metadata is limited to a shallow copy due to the unlimited type of value in the map. Other fields can be regarded as deep clone.
    
    Overrides:
    
    clone in class Object
  - isRequesterCharged
```
public boolean isRequesterCharged()
```
    Returns the AWS Key Management System encryption context used for Server Side Encryption of the Amazon S3 object.
    
    Specified by:
    
    isRequesterCharged in interface S3RequesterChargedResult
    
    Returns:
    
    true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.
  - setRequesterCharged
```
public void setRequesterCharged(boolean isRequesterCharged)
```
    Description copied from interface: S3RequesterChargedResult
    
    Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for conducting the operation from the bucket.
    If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
    
    Specified by:
    
    setRequesterCharged in interface S3RequesterChargedResult
    
    Parameters:
    
    isRequesterCharged - Indicates requester is charged for this operation.
  - getRetentionExpirationDate
```
public Date getRetentionExpirationDate()
```
  - setRetentionExpirationDate
```
public void setRetentionExpirationDate(Date retentionExpirationDate)
```
  - getRetentionLegalHoldCount
```
public Integer getRetentionLegalHoldCount()
```
  - setRetentionLegalHoldCount
```
public void setRetentionLegalHoldCount(Integer retentionLegalHoldCount)
```
  - getRetentionPeriod
```
public Long getRetentionPeriod()
```
  - setRetentionPeriod
```
public void setRetentionPeriod(Long retentionPeriod)
```
  - getPartCount
```
public Integer getPartCount()
```
    Returns the value of x-amz-mp-parts-count header.
    
    The x-amz-mp-parts-count header is returned in the response only when a valid partNumber is specified in the request and the object has more than 1 part.
    
    To find the part count of an object, set the partNumber to 1 in GetObjectRequest. If the object has more than 1 part then part count will be returned, otherwise null is returned.
  - getContentRange
```
public Long[] getContentRange()
```
    Returns the content range of the object if response contains the Content-Range header.
    
    If the request specifies a range or part number, then response returns the Content-Range range header. Otherwise, the response does not return Content-Range header.
    
    Returns:
    
    Returns content range if the object is requested with specific range or part number, null otherwise.
  - getReplicationStatus
```
public String getReplicationStatus()
```
    Returns:
    
    The replication status of the object if it is from a bucket that is the source or destination in a cross-region replication.
  - getObjectLockMode
```
public String getObjectLockMode()
```
    The Object Lock mode applied to this object.
  - getObjectLockRetainUntilDate
```
public Date getObjectLockRetainUntilDate()
```
    The date and time this object's Object Lock will expire.
  - getObjectLockLegalHoldStatus
```
public String getObjectLockLegalHoldStatus()
```
    The Legal Hold status of the specified object.

Class ObjectMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AES_256_SERVER_SIDE_ENCRYPTION

Constructor Detail

ObjectMetadata

Method Detail

getUserMetadata

setUserMetadata

setHeader

addUserMetadata

getRawMetadata

getRawMetadataValue

getLastModified

setLastModified

getContentLength

getInstanceLength

setContentLength

getContentType

setContentType

getContentLanguage

setContentLanguage

getContentEncoding

setContentEncoding

getCacheControl

setCacheControl

setContentMD5

getContentMD5

setContentDisposition

getContentDisposition

getETag

getVersionId

getSSEAlgorithm

getServerSideEncryption

setSSEAlgorithm

setServerSideEncryption

getSSECustomerAlgorithm

setSSECustomerAlgorithm

getSSECustomerKeyMd5

setSSECustomerKeyMd5

getIbmTransition

getIbmRestoredCopyStorageClass

getExpirationTime

setExpirationTime

getExpirationTimeRuleId

setExpirationTimeRuleId

getRestoreExpirationTime

setRestoreExpirationTime

setOngoingRestore

getOngoingRestore

getTransitionDate

setTransitionDate

setTransition

getTransition

setHttpExpiresDate

getHttpExpiresDate

getStorageClass

getArchiveStatus

getUserMetaDataOf

clone

isRequesterCharged

setRequesterCharged

getRetentionExpirationDate

setRetentionExpirationDate

getRetentionLegalHoldCount

setRetentionLegalHoldCount

getRetentionPeriod

setRetentionPeriod

getPartCount

getContentRange

getReplicationStatus

getObjectLockMode

getObjectLockRetainUntilDate

getObjectLockLegalHoldStatus