com.amazonaws.services.s3.model

## クラス InitiateMultipartUploadRequest

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

-     public class InitiateMultipartUploadRequest
      extends AmazonWebServiceRequest

  The InitiateMultipartUploadRequest contains the parameters used for the InitiateMultipartUpload method.

  Required Parameters: BucketName, Key

  関連項目:
    `AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest)`

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

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `ObjectMetadata` | `objectMetadata` Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

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

    コンストラクタ
    コンストラクタと説明
    `InitiateMultipartUploadRequest(java.lang.String bucketName, java.lang.String key)` Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key.
    `InitiateMultipartUploadRequest(java.lang.String bucketName, java.lang.String key, ObjectMetadata objectMetadata)` Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key, and with the additional specified object metadata.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `AccessControlList` | `getAccessControlList()` Returns the optional access control list for the new upload.
    `java.lang.String` | `getBucketName()` Returns the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
    `CannedAccessControlList` | `getCannedACL()` Returns the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
    `java.lang.String` | `getKey()` Returns the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
    `ObjectMetadata` | `getObjectMetadata()` Returns the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
    `java.lang.String` | `getRedirectLocation()` Gets the optional redirect location for the new object.
    `StorageClass` | `getStorageClass()` Returns the optional storage class to use when storing this upload's data in S3.
    `void` | `setAccessControlList(AccessControlList accessControlList)` Sets the optional access control list for the new upload.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
    `void` | `setCannedACL(CannedAccessControlList cannedACL)` Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
    `void` | `setKey(java.lang.String key)` Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
    `void` | `setObjectMetadata(ObjectMetadata objectMetadata)` Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
    `void` | `setRedirectLocation(java.lang.String redirectLocation)` Sets the optional redirect location for the new object.
    `void` | `setStorageClass(StorageClass storageClass)` Sets the optional storage class to use when storing this upload's data in S3.
    `InitiateMultipartUploadRequest` | `withAccessControlList(AccessControlList accessControlList)` Sets the optional access control list for the new upload.
    `InitiateMultipartUploadRequest` | `withBucketName(java.lang.String bucketName)` Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
    `InitiateMultipartUploadRequest` | `withCannedACL(CannedAccessControlList acl)` Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
    `InitiateMultipartUploadRequest` | `withKey(java.lang.String key)` Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
    `InitiateMultipartUploadRequest` | `withObjectMetadata(ObjectMetadata objectMetadata)` Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
    `InitiateMultipartUploadRequest` | `withRedirectLocation(java.lang.String redirectLocation)` Sets the optional redirect location for the new object.
    `InitiateMultipartUploadRequest` | `withStorageClass(StorageClass storageClass)` Sets the optional storage class to use when storing this upload's data in S3.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### objectMetadata

          public ObjectMetadata objectMetadata

      Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

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

    - #### InitiateMultipartUploadRequest

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

      Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key.
      パラメータ:
        `bucketName` - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
        `key` - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

    - #### InitiateMultipartUploadRequest

          public InitiateMultipartUploadRequest(java.lang.String bucketName,
                                        java.lang.String key,
                                        ObjectMetadata objectMetadata)

      Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key, and with the additional specified object metadata.
      パラメータ:
        `bucketName` - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
        `key` - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
        `objectMetadata` - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Returns the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
      戻り値:
        The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
      パラメータ:
        `bucketName` - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

    - #### withBucketName

          public InitiateMultipartUploadRequest withBucketName(java.lang.String bucketName)

      Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

      Returns this updated InitiateMultipartUploadRequest object so that additional method calls can be chained together.

      パラメータ:
        `bucketName` - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
      戻り値:
        This updated InitiateMultipartUploadRequest object.

    - #### getKey

          public java.lang.String getKey()

      Returns the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
      戻り値:
        The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

    - #### setKey

          public void setKey(java.lang.String key)

      Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
      パラメータ:
        `key` - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

    - #### withKey

          public InitiateMultipartUploadRequest withKey(java.lang.String key)

      Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

      Returns this updated InitiateMultipartUploadRequest object so that additional method calls can be chained together.

      パラメータ:
        `key` - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
      戻り値:
        This updated InitiateMultipartUploadRequest object.

    - #### getCannedACL

          public CannedAccessControlList getCannedACL()

      Returns the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
      戻り値:
        The optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
      関連項目:
        `CannedAccessControlList`

    - #### setCannedACL

          public void setCannedACL(CannedAccessControlList cannedACL)

      Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
      パラメータ:
        `cannedACL` - The canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
      関連項目:
        `CannedAccessControlList`

    - #### withCannedACL

          public InitiateMultipartUploadRequest withCannedACL(CannedAccessControlList acl)

      Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

      Returns this updated InitiateMultipartUploadRequest object so that additional method calls can be chained together.

      パラメータ:
        `acl` - The optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
      戻り値:
        This updated InitiateMultipartUploadRequest object.

    - #### getAccessControlList

          public AccessControlList getAccessControlList()

      Returns the optional access control list for the new upload. If specified, cannedAcl will be ignored.

    - #### setAccessControlList

          public void setAccessControlList(AccessControlList accessControlList)

      Sets the optional access control list for the new upload. If specified, cannedAcl will be ignored.
      パラメータ:
        `accessControlList` - The access control list for the new upload.

    - #### withAccessControlList

          public InitiateMultipartUploadRequest withAccessControlList(AccessControlList accessControlList)

      Sets the optional access control list for the new upload. If specified, cannedAcl will be ignored. Returns this `InitiateMultipartUploadRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `accessControlList` - The access control list for the new upload.

    - #### getStorageClass

          public StorageClass getStorageClass()

      Returns the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

      If not specified, the default is `StorageClass.Standard`.

      戻り値:
        The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.
      関連項目:
        `StorageClass`

    - #### setStorageClass

          public void setStorageClass(StorageClass storageClass)

      Sets the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

      If not specified, the default is `StorageClass.Standard`.

      パラメータ:
        `storageClass` - The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.
      関連項目:
        `StorageClass`

    - #### withStorageClass

          public InitiateMultipartUploadRequest withStorageClass(StorageClass storageClass)

      Sets the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

      Returns this updated InitiateMultipartUploadRequest object so that additional method calls can be chained together.

      パラメータ:
        `storageClass` - The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.
      戻り値:
        This updated InitiateMultipartUploadRequest object.

    - #### getObjectMetadata

          public ObjectMetadata getObjectMetadata()

      Returns the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
      戻り値:
        The additional information about the new object being created, such as content type, content encoding, user metadata, etc.

    - #### setObjectMetadata

          public void setObjectMetadata(ObjectMetadata objectMetadata)

      Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
      パラメータ:
        `objectMetadata` - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

    - #### withObjectMetadata

          public InitiateMultipartUploadRequest withObjectMetadata(ObjectMetadata objectMetadata)

      Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.

      Returns this updated InitiateMultipartUploadRequest object so that additional method calls can be chained together.

      パラメータ:
        `objectMetadata` - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.
      戻り値:
        This updated InitiateMultipartUploadRequest object.

    - #### setRedirectLocation

          public void setRedirectLocation(java.lang.String redirectLocation)

      Sets the optional redirect location for the new object.
      パラメータ:
        `redirectLocation` - The redirect location for the new object.

    - #### getRedirectLocation

          public java.lang.String getRedirectLocation()

      Gets the optional redirect location for the new object.

    - #### withRedirectLocation

          public InitiateMultipartUploadRequest withRedirectLocation(java.lang.String redirectLocation)

      Sets the optional redirect location for the new object. Returns this `InitiateMultipartUploadRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `redirectLocation` - The redirect location for the new object.