com.amazonaws.services.s3.model

## クラス ObjectMetadata

- java.lang.Object
- - com.amazonaws.services.s3.model.ObjectMetadata

- すべての実装されたインタフェース:
    ObjectExpirationResult, ObjectRestoreResult, ServerSideEncryptionResult

      public class ObjectMetadata
      extends java.lang.Object
      implements ServerSideEncryptionResult, ObjectExpirationResult, ObjectRestoreResult

  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.).

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static java.lang.String` | `AES_256_SERVER_SIDE_ENCRYPTION`

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `ObjectMetadata()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addUserMetadata(java.lang.String key, java.lang.String value)` Adds the key value pair of custom user-metadata for the associated object.
    `java.lang.String` | `getCacheControl()` Gets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.
    `java.lang.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.
    `java.lang.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.
    `long` | `getContentLength()` Gets the Content-Length HTTP header indicating the size of the associated object in bytes.
    `java.lang.String` | `getContentMD5()` Gets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
    `java.lang.String` | `getContentType()` Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object.
    `java.lang.String` | `getETag()` Gets the hex encoded 128-bit MD5 digest of the associated object according to RFC 1864.
    `java.util.Date` | `getExpirationTime()` Returns the expiration time for this object, or null if it doesn't expire.
    `java.lang.String` | `getExpirationTimeRuleId()` Returns the `BucketLifecycleConfiguration` rule ID for this object's expiration, or null if it doesn't expire.
    `java.util.Date` | `getHttpExpiresDate()` Returns the date when the object is no longer cacheable.
    `java.util.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.
    `java.lang.Boolean` | `getOngoingRestore()` Returns the boolean value which indicates whether there is ongoing restore request.
    `java.util.Map<java.lang.String,java.lang.Object>` | `getRawMetadata()` For internal use only.
    `java.util.Date` | `getRestoreExpirationTime()` Returns the expiration time when the object is scheduled to move to Amazon Glacier, or null if it doesn't expire.
    `java.lang.String` | `getServerSideEncryption()` Returns the server-side encryption algorithm for the object, or null if none was used.
    `java.util.Map<java.lang.String,java.lang.String>` | `getUserMetadata()` Gets the custom user-metadata for the associated object.
    `java.lang.String` | `getVersionId()` Gets the version ID of the associated Amazon S3 object if available.
    `void` | `setCacheControl(java.lang.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(java.lang.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(java.lang.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` | `setContentLength(long contentLength)` Sets the Content-Length HTTP header indicating the size of the associated object in bytes.
    `void` | `setContentMD5(java.lang.String md5Base64)` Sets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
    `void` | `setContentType(java.lang.String contentType)` Sets the Content-Type HTTP header indicating the type of content stored in the associated object.
    `void` | `setExpirationTime(java.util.Date expirationTime)` For internal use only.
    `void` | `setExpirationTimeRuleId(java.lang.String expirationTimeRuleId)` Sets the `BucketLifecycleConfiguration` rule ID for this object's expiration
    `void` | `setHeader(java.lang.String key, java.lang.Object value)` For internal use only.
    `void` | `setHttpExpiresDate(java.util.Date httpExpiresDate)` Set the date when the object is no longer cacheable.
    `void` | `setLastModified(java.util.Date lastModified)` For internal use only.
    `void` | `setOngoingRestore(boolean ongoingRestore)` For internal use only.
    `void` | `setRestoreExpirationTime(java.util.Date restoreExpirationTime)` Sets the expiration time when the object is scheduled to move to Amazon Glacier.
    `void` | `setServerSideEncryption(java.lang.String serverSideEncryption)` Sets the server-side encryption algorithm for the object.
    `void` | `setUserMetadata(java.util.Map<java.lang.String,java.lang.String> userMetadata)` Sets the custom user-metadata for the associated object.

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### フィールドの詳細

    - #### AES_256_SERVER_SIDE_ENCRYPTION

          public static final java.lang.String AES_256_SERVER_SIDE_ENCRYPTION

      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### ObjectMetadata

          public ObjectMetadata()

  - ### メソッドの詳細

    - #### getUserMetadata

          public java.util.Map<java.lang.String,java.lang.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.

      戻り値:
        The custom user metadata for the associated object.
      関連項目:
        `setUserMetadata(Map)`, `addUserMetadata(String, String)`

    - #### setUserMetadata

          public void setUserMetadata(java.util.Map<java.lang.String,java.lang.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.

      パラメータ:
        `userMetadata` - The custom user-metadata for the associated object. Note that the key should not include the internal S3 HTTP header prefix.
      関連項目:
        `getUserMetadata()`, `addUserMetadata(String, String)`

    - #### setHeader

          public void setHeader(java.lang.String key,
                       java.lang.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(java.lang.String key,
                             java.lang.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.

      パラメータ:
        `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.
      関連項目:
        `setUserMetadata(Map)`, `getUserMetadata()`

    - #### getRawMetadata

          public java.util.Map<java.lang.String,java.lang.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.

    - #### getLastModified

          public java.util.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.
      戻り値:
        The date and time at which Amazon S3 last recorded a modification to the associated object. Returns `null` if the Last-Modified header hasn't been set.

    - #### setLastModified

          public void setLastModified(java.util.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.
      パラメータ:
        `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 AWS 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 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 S3, but the AWS 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 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 java.lang.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 AWS 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 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 S3 object. Returns `null` if it hasn't been set.
      関連項目:
        `setContentType(String)`

    - #### setContentType

          public void setContentType(java.lang.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 AWS 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 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 S3 object.
      関連項目:
        `getContentType()`

    - #### getContentEncoding

          public java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 represents the hex encoded 128-bit MD5 digest as computed by Amazon S3.

      The AWS S3 Java client will attempt to calculate this field automatically when uploading files to Amazon S3.

      パラメータ:
        `md5Base64` - The base64 encoded MD5 hash of the content for the object associated with this metadata.
      関連項目:
        `getContentMD5()`

    - #### getContentMD5

          public java.lang.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 represents the hex encoded 128-bit MD5 digest as computed by Amazon S3.

      The AWS S3 Java client will attempt to calculate this field automatically when uploading files to Amazon S3.

      戻り値:
        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(java.lang.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 java.lang.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 java.lang.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 Amazon S3.

      This field represents the hex encoded 128-bit MD5 digest of an object's content as calculated by Amazon S3. 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 Amazon S3. Returns `null` if it hasn't been set yet.

    - #### getVersionId

          public java.lang.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.
      戻り値:
        The version ID of the associated Amazon S3 object if available.

    - #### getServerSideEncryption

          public java.lang.String getServerSideEncryption()

      Returns the server-side encryption algorithm for the object, or null if none was used.
      定義:
        `getServerSideEncryption` インタフェース内 `ServerSideEncryptionResult`

    - #### setServerSideEncryption

          public void setServerSideEncryption(java.lang.String serverSideEncryption)

      Sets the server-side encryption algorithm for the object.
      定義:
        `setServerSideEncryption` インタフェース内 `ServerSideEncryptionResult`
      パラメータ:
        `serverSideEncryption` - The server-side encryption algorithm for the object.

    - #### getExpirationTime

          public java.util.Date getExpirationTime()

      Returns the expiration time for this object, or null if it doesn't expire.
      定義:
        `getExpirationTime` インタフェース内 `ObjectExpirationResult`

    - #### setExpirationTime

          public void setExpirationTime(java.util.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.
      定義:
        `setExpirationTime` インタフェース内 `ObjectExpirationResult`
      パラメータ:
        `expirationTime` - The expiration time for the object.

    - #### getExpirationTimeRuleId

          public java.lang.String getExpirationTimeRuleId()

      Returns the `BucketLifecycleConfiguration` rule ID for this object's expiration, or null if it doesn't expire.
      定義:
        `getExpirationTimeRuleId` インタフェース内 `ObjectExpirationResult`
      関連項目:
        `BucketLifecycleConfiguration.Rule.getId()`

    - #### setExpirationTimeRuleId

          public void setExpirationTimeRuleId(java.lang.String expirationTimeRuleId)

      Sets the `BucketLifecycleConfiguration` rule ID for this object's expiration
      定義:
        `setExpirationTimeRuleId` インタフェース内 `ObjectExpirationResult`
      パラメータ:
        `expirationTimeRuleId` - The rule ID for this object's expiration

    - #### getRestoreExpirationTime

          public java.util.Date getRestoreExpirationTime()

      Returns the expiration time when the object is scheduled to move to Amazon Glacier, or null if it doesn't expire.
      定義:
        `getRestoreExpirationTime` インタフェース内 `ObjectRestoreResult`

    - #### setRestoreExpirationTime

          public void setRestoreExpirationTime(java.util.Date restoreExpirationTime)

      Sets the expiration time when the object is scheduled to move to Amazon Glacier.
      定義:
        `setRestoreExpirationTime` インタフェース内 `ObjectRestoreResult`
      パラメータ:
        `expirationTime` - The expiration time for the object to move to.

    - #### 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 java.lang.Boolean getOngoingRestore()

      Returns the boolean value which indicates whether there is ongoing restore request.
      定義:
        `getOngoingRestore` インタフェース内 `ObjectRestoreResult`

    - #### setHttpExpiresDate

          public void setHttpExpiresDate(java.util.Date httpExpiresDate)

      Set the date when the object is no longer cacheable.

    - #### getHttpExpiresDate

          public java.util.Date getHttpExpiresDate()

      Returns the date when the object is no longer cacheable.