com.amazonaws.services.s3.model

## クラス GetObjectMetadataRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.s3.model.GetObjectMetadataRequest

-     public class GetObjectMetadataRequest
      extends AmazonWebServiceRequest

  Provides options for obtaining the metadata for the specified Amazon S3 object without actually fetching the object contents. This is useful if obtaining only object metadata, and avoids wasting bandwidth from retrieving the object data.

  The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in Amazon S3.

  For more information about enabling versioning for a bucket, see `AmazonS3#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)`.

  関連項目:
    `GetObjectMetadataRequest(String, String)`, `GetObjectMetadataRequest(String, String, String)`, `GetObjectRequest`

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

    コンストラクタ
    コンストラクタと説明
    `GetObjectMetadataRequest(java.lang.String bucketName, java.lang.String key)` Constructs a new `GetObjectMetadataRequest` used to retrieve a specified object's metadata.
    `GetObjectMetadataRequest(java.lang.String bucketName, java.lang.String key, java.lang.String versionId)` Constructs a new `GetObjectMetadataRequest` with basic options.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the bucket containing the object whose metadata is being retrieved.
    `java.lang.String` | `getKey()` Gets the key of the object whose metadata is being retrieved.
    `java.lang.String` | `getVersionId()` Gets the optional version ID of the object version whose metadata is being retrieved.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the bucket containing the object whose metadata is being retrieved.
    `void` | `setKey(java.lang.String key)` Sets the key of the object whose metadata is being retrieved.
    `void` | `setVersionId(java.lang.String versionId)` Sets the optional version ID of the object version whose metadata is being retrieved.
    `GetObjectMetadataRequest` | `withBucketName(java.lang.String bucketName)` Sets the name of the bucket containing the object whose metadata is being retrieved.
    `GetObjectMetadataRequest` | `withKey(java.lang.String key)` Sets the key of the object whose metadata is being retrieved.
    `GetObjectMetadataRequest` | `withVersionId(java.lang.String versionId)` Sets the optional version ID of the object version whose metadata is being retrieved.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### GetObjectMetadataRequest

          public GetObjectMetadataRequest(java.lang.String bucketName,
                                  java.lang.String key)

      Constructs a new `GetObjectMetadataRequest` used to retrieve a specified object's metadata.
      パラメータ:
        `bucketName` - The name of the bucket containing the object whose metadata is being retrieved.
        `key` - The key of the object whose metadata is being retrieved.
      関連項目:
        `GetObjectMetadataRequest(String bucketName, String key, String versionId)`

    - #### GetObjectMetadataRequest

          public GetObjectMetadataRequest(java.lang.String bucketName,
                                  java.lang.String key,
                                  java.lang.String versionId)

      Constructs a new `GetObjectMetadataRequest` with basic options.
      パラメータ:
        `bucketName` - The name of the bucket containing the object whose metadata is being retrieved.
        `key` - The key of the object whose metadata is being retrieved.
        `versionId` - The version ID of the object version whose metadata is being retrieved.
      関連項目:
        `GetObjectMetadataRequest(String bucketName, String key)`

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the bucket containing the object whose metadata is being retrieved.
      戻り値:
        The name of the bucket containing the object whose metadata is being retrieved.
      関連項目:
        `setBucketName(String bucketName)`, `withBucketName(String)`

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the bucket containing the object whose metadata is being retrieved.
      パラメータ:
        `bucketName` - The name of the bucket containing the object's whose metadata is being retrieved.
      関連項目:
        `getBucketName()`, `withBucketName(String)`

    - #### withBucketName

          public GetObjectMetadataRequest withBucketName(java.lang.String bucketName)

      Sets the name of the bucket containing the object whose metadata is being retrieved. Returns this `GetObjectMetadataRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `bucketName` - The name of the bucket containing the object's whose metadata is being retrieved.
      戻り値:
        This `GetObjectMetadataRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getBucketName()`, `setBucketName(String bucketName)`

    - #### getKey

          public java.lang.String getKey()

      Gets the key of the object whose metadata is being retrieved.
      戻り値:
        The key of the object whose metadata is being retrieved.
      関連項目:
        `setKey(String)`, `withKey(String)`

    - #### setKey

          public void setKey(java.lang.String key)

      Sets the key of the object whose metadata is being retrieved.
      パラメータ:
        `key` - The key of the object whose metadata is being retrieved.
      関連項目:
        `getKey()`, `withKey(String)`

    - #### withKey

          public GetObjectMetadataRequest withKey(java.lang.String key)

      Sets the key of the object whose metadata is being retrieved. Returns this `GetObjectMetadataRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `key` - The key of the object whose metadata is being retrieved.
      戻り値:
        This `GetObjectMetadataRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getKey()`, `setKey(String)`

    - #### getVersionId

          public java.lang.String getVersionId()

      Gets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
      戻り値:
        The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
      関連項目:
        `setVersionId(String)`, `withVersionId(String)`

    - #### setVersionId

          public void setVersionId(java.lang.String versionId)

      Sets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
      パラメータ:
        `versionId` - The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
      関連項目:
        `getVersionId()`, `withVersionId(String)`

    - #### withVersionId

          public GetObjectMetadataRequest withVersionId(java.lang.String versionId)

      Sets the optional version ID of the object version whose metadata is being retrieved. Returns this `GetObjectMetadataRequest`, enabling additional method calls to be chained together. If not specified, the latest version will be used.
      パラメータ:
        `versionId` - The optional version ID of the object version whose metadata is being retrieved.
      戻り値:
        This `GetObjectMetadataRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getVersionId()`, `setVersionId(String)`