com.amazonaws.services.s3.model

## クラス DeleteObjectsRequest

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

-     public class DeleteObjectsRequest
      extends AmazonWebServiceRequest

  Provides options for deleting multiple objects in a specified bucket. Once deleted, the object(s) can only be restored if versioning was enabled when the object(s) was deleted.

  関連項目:
    `AmazonS3.deleteObjects(DeleteObjectsRequest)`

- - ### ネストされたクラスの概要

    ネストされたクラス
    修飾子とタイプ | クラスと説明
    --- | ---
    `static class` | `DeleteObjectsRequest.KeyVersion` A key to delete, with an optional version attribute.

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

    コンストラクタ
    コンストラクタと説明
    `DeleteObjectsRequest(java.lang.String bucketName)` Constructs a new `DeleteObjectsRequest`, specifying the objects' bucket name.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the Amazon S3 bucket containing the object(s) to delete.
    `java.util.List<DeleteObjectsRequest.KeyVersion>` | `getKeys()` Returns the list of keys to delete from this bucket.
    `MultiFactorAuthentication` | `getMfa()` Gets the optional Multi-Factor Authentication information included with this request.
    `boolean` | `getQuiet()` Returns the quiet element for this request.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the Amazon S3 bucket containing the object(s) to delete.
    `void` | `setKeys(java.util.List<DeleteObjectsRequest.KeyVersion> keys)` Sets the list of keys to delete from this bucket, clearing any existing list of keys.
    `void` | `setMfa(MultiFactorAuthentication mfa)` Sets the optional Multi-Factor Authentication information to include with this request.
    `void` | `setQuiet(boolean quiet)` Sets the quiet element for this request.
    `DeleteObjectsRequest` | `withBucketName(java.lang.String bucketName)` Sets the name of the Amazon S3 bucket containing the object(s) to delete and returns this object, enabling additional method calls to be chained together.
    `DeleteObjectsRequest` | `withKeys(java.util.List<DeleteObjectsRequest.KeyVersion> keys)` Sets the list of keys to delete from this bucket, clearing any existing list of keys.
    `DeleteObjectsRequest` | `withKeys(java.lang.String... keys)` Convenience method to specify a set of keys without versions.
    `DeleteObjectsRequest` | `withMfa(MultiFactorAuthentication mfa)` Sets the optional Multi-Factor Authentication information to include with this request Returns this, enabling additional method calls to be chained together.
    `DeleteObjectsRequest` | `withQuiet(boolean quiet)` Sets the quiet element for this request.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### DeleteObjectsRequest

          public DeleteObjectsRequest(java.lang.String bucketName)

      Constructs a new `DeleteObjectsRequest`, specifying the objects' bucket name.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket containing the object(s) to delete.

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the Amazon S3 bucket containing the object(s) to delete.
      戻り値:
        The name of the Amazon S3 bucket containing the object(s) to delete.
      関連項目:
        `setBucketName(String)`

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the Amazon S3 bucket containing the object(s) to delete.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket containing the object(s) to delete.
      関連項目:
        `getBucketName()`

    - #### withBucketName

          public DeleteObjectsRequest withBucketName(java.lang.String bucketName)

      Sets the name of the Amazon S3 bucket containing the object(s) to delete and returns this object, enabling additional method calls to be chained together.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket containing the object(s) to delete.
      戻り値:
        The updated `DeleteObjectsRequest` object, enabling additional method calls to be chained together.

    - #### getMfa

          public MultiFactorAuthentication getMfa()

      Gets the optional Multi-Factor Authentication information included with this request.

      Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.

      See `BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)` for more information on MFADelete.

      戻り値:
        The optional Multi-Factor Authentication information included with this request.

    - #### setMfa

          public void setMfa(MultiFactorAuthentication mfa)

      Sets the optional Multi-Factor Authentication information to include with this request.

      Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.

      See `BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)` for more information on MFADelete.

      パラメータ:
        `mfa` - The optional Multi-Factor Authentication information to include with this request.

    - #### withMfa

          public DeleteObjectsRequest withMfa(MultiFactorAuthentication mfa)

      Sets the optional Multi-Factor Authentication information to include with this request Returns this, enabling additional method calls to be chained together.

      Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration

      See `BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)` for more information on MFADelete.

      パラメータ:
        `mfa` - The optional Multi-Factor Authentication information to include with this request.
      戻り値:
        this, enabling additional method calls to be chained together.

    - #### setQuiet

          public void setQuiet(boolean quiet)

      Sets the quiet element for this request. When true, only errors will be returned in the service response.

    - #### getQuiet

          public boolean getQuiet()

      Returns the quiet element for this request. When true, only errors will be returned in the service response.

    - #### withQuiet

          public DeleteObjectsRequest withQuiet(boolean quiet)

      Sets the quiet element for this request. When true, only errors will be returned in the service response.
      戻り値:
        this, to chain multiple calls together.

    - #### setKeys

          public void setKeys(java.util.List<DeleteObjectsRequest.KeyVersion> keys)

      Sets the list of keys to delete from this bucket, clearing any existing list of keys.
      パラメータ:
        `keys` - The list of keys to delete from this bucket

    - #### withKeys

          public DeleteObjectsRequest withKeys(java.util.List<DeleteObjectsRequest.KeyVersion> keys)

      Sets the list of keys to delete from this bucket, clearing any existing list of keys.
      パラメータ:
        `keys` - The list of keys to delete from this bucket
      戻り値:
        this, to chain multiple calls togethers.

    - #### getKeys

          public java.util.List<DeleteObjectsRequest.KeyVersion> getKeys()

      Returns the list of keys to delete from this bucket.

    - #### withKeys

          public DeleteObjectsRequest withKeys(java.lang.String... keys)

      Convenience method to specify a set of keys without versions.
      関連項目:
        `withKeys(List)`