com.amazonaws.services.s3.model

## クラス SetBucketVersioningConfigurationRequest

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

-     public class SetBucketVersioningConfigurationRequest
      extends AmazonWebServiceRequest

  Contains options for setting the versioning configuration for a bucket.

  A bucket's versioning configuration can be in one of three possible states:

  - `BucketVersioningConfiguration.OFF`
  - `BucketVersioningConfiguration.ENABLED`
  - `BucketVersioningConfiguration.SUSPENDED`

  By default, new buckets are created in the `BucketVersioningConfiguration.OFF` state. Once versioning is enabled for a bucket, its status can never be reverted to `off`.

  Objects created before versioning is enabled or while versioning is suspended will be given the default `null` version ID (see `Constants.NULL_VERSION_ID`). Note that the `null` version ID is a valid version ID and is not the same as having no version ID.

  The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. When versioning is enabled, a `PutObject` operation creates a unique object version ID for the object being uploaded. The `PutObject` operation guarantees that if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted by calling the `DeleteVersion` operation and can never be overwritten.

  Additionally, the `PutObject` operation guarantees that if versioning is enabled for a bucket at the time of the request, no other object will be overwritten by that request. Refer to the documentation sections for individual APIs for information on how versioning status affects the semantics of that particular API.

  Amazon S3 is eventually consistent. It may take time for the versioning status of a bucket to be propagated throughout the system.

  関連項目:
    `SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration)`, `SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration, MultiFactorAuthentication)`

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

    コンストラクタ
    コンストラクタと説明
    `SetBucketVersioningConfigurationRequest(java.lang.String bucketName, BucketVersioningConfiguration configuration)` Constructs a new `SetBucketVersioningConfigurationRequest` to set the bucket versioning configuration of the specified bucket.
    `SetBucketVersioningConfigurationRequest(java.lang.String bucketName, BucketVersioningConfiguration configuration, MultiFactorAuthentication mfa)` Constructs a new `SetBucketVersioningConfigurationRequest` to set the bucket versioning configuration of the specified bucket, including the specified Multi-Factor Authentication (MFA) information, which is required when changing the state of the MFA Delete option.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the bucket whose versioning configuration is being set.
    `MultiFactorAuthentication` | `getMfa()` Gets the optional Multi-Factor Authentication information included with this request.
    `BucketVersioningConfiguration` | `getVersioningConfiguration()` Gets the new versioning configuration for the specified bucket.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the bucket whose versioning configuration is being set.
    `void` | `setMfa(MultiFactorAuthentication mfa)` Sets the optional Multi-Factor Authentication information to include with this request.
    `void` | `setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)` Sets the new versioning configuration for the specified bucket.
    `SetBucketVersioningConfigurationRequest` | `withBucketName(java.lang.String bucketName)` Sets the name of the bucket whose versioning configuration is being set, and returns this object so that additional method calls may be chained together.
    `SetBucketVersioningConfigurationRequest` | `withMfa(MultiFactorAuthentication mfa)` Sets the optional Multi-Factor Authentication information to include with this request, and returns this object so that additional method calls may be chained together.
    `SetBucketVersioningConfigurationRequest` | `withVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)` Sets the new versioning configuration for the specified bucket and returns this object, enabling additional method calls to be chained together.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### SetBucketVersioningConfigurationRequest

          public SetBucketVersioningConfigurationRequest(java.lang.String bucketName,
                                                 BucketVersioningConfiguration configuration)

      Constructs a new `SetBucketVersioningConfigurationRequest` to set the bucket versioning configuration of the specified bucket.
      パラメータ:
        `bucketName` - The name of the bucket whose versioning configuration is being set.
        `configuration` - The new versioning configuration for the specified bucket.
      関連項目:
        `SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration, MultiFactorAuthentication)`

    - #### SetBucketVersioningConfigurationRequest

          public SetBucketVersioningConfigurationRequest(java.lang.String bucketName,
                                                 BucketVersioningConfiguration configuration,
                                                 MultiFactorAuthentication mfa)

      Constructs a new `SetBucketVersioningConfigurationRequest` to set the bucket versioning configuration of the specified bucket, including the specified Multi-Factor Authentication (MFA) information, which is required when changing the state of the MFA Delete option.
      パラメータ:
        `bucketName` - The name of the bucket whose versioning configuration is being set.
        `configuration` - The new versioning configuration for the specified bucket.
        `mfa` - The Multi-Factor Authentication information to include in this request.
      関連項目:
        `SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration)`

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the bucket whose versioning configuration is being set.
      戻り値:
        The name of the bucket whose versioning configuration is being set.
      関連項目:
        `setBucketName(String)`

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the bucket whose versioning configuration is being set.
      パラメータ:
        `bucketName` - The name of the bucket whose versioning configuration is being set.
      関連項目:
        `getBucketName()`

    - #### withBucketName

          public SetBucketVersioningConfigurationRequest withBucketName(java.lang.String bucketName)

      Sets the name of the bucket whose versioning configuration is being set, and returns this object so that additional method calls may be chained together.
      パラメータ:
        `bucketName` - The name of the bucket whose versioning configuration is being set.
      戻り値:
        This `SetBucketVersioningConfigurationRequest` object so that additional method calls may be chained together.
      関連項目:
        `setBucketName(String)`

    - #### getVersioningConfiguration

          public BucketVersioningConfiguration getVersioningConfiguration()

      Gets the new versioning configuration for the specified bucket.
      戻り値:
        The new versioning configuration for the specified bucket.
      関連項目:
        `setVersioningConfiguration(BucketVersioningConfiguration)`, `withVersioningConfiguration(BucketVersioningConfiguration)`

    - #### setVersioningConfiguration

          public void setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)

      Sets the new versioning configuration for the specified bucket.
      パラメータ:
        `versioningConfiguration` - The new versioning configuration for the specified bucket.
      関連項目:
        `getVersioningConfiguration()`, `withVersioningConfiguration(BucketVersioningConfiguration)`

    - #### withVersioningConfiguration

          public SetBucketVersioningConfigurationRequest withVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)

      Sets the new versioning configuration for the specified bucket and returns this object, enabling additional method calls to be chained together.
      パラメータ:
        `versioningConfiguration` - The new versioning configuration for the specified bucket.
      戻り値:
        This `SetBucketVersioningConfigurationRequest` object, enabling that additional method calls may be chained together.
      関連項目:
        `getVersioningConfiguration()`, `getVersioningConfiguration()`

    - #### getMfa

          public MultiFactorAuthentication getMfa()

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

      Multi-Factor Authentication is required when enabling or disabling MFA Delete functionality for a bucket.

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

      戻り値:
        The optional Multi-Factor Authentication information included with this request.
      関連項目:
        `setMfa(MultiFactorAuthentication)`, `withMfa(MultiFactorAuthentication)`

    - #### setMfa

          public void setMfa(MultiFactorAuthentication mfa)

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

      Multi-Factor Authentication is required when enabling or disabling MFA delete functionality for a bucket.

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

      パラメータ:
        `mfa` - The optional Multi-Factor Authentication information to include with this request.
      関連項目:
        `getMfa()`, `withMfa(MultiFactorAuthentication)`

    - #### withMfa

          public SetBucketVersioningConfigurationRequest withMfa(MultiFactorAuthentication mfa)

      Sets the optional Multi-Factor Authentication information to include with this request, and returns this object so that additional method calls may be chained together.

      Multi-Factor Authentication is required when enabling or disabling MFA delete functionality for a bucket.

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

      パラメータ:
        `mfa` - The optional Multi-Factor Authentication information to include with this request.
      戻り値:
        The updated SetBucketVersioningConfigurationRequest object so that additional method calls may be chained together.
      関連項目:
        `getMfa()`, `setMfa(MultiFactorAuthentication)`