Interface PutBucketInventoryConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutBucketInventoryConfigurationRequest.Builder,PutBucketInventoryConfigurationRequest>, S3Request.Builder, SdkBuilder<PutBucketInventoryConfigurationRequest.Builder,PutBucketInventoryConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutBucketInventoryConfigurationRequest
@Mutable @NotThreadSafe public static interface PutBucketInventoryConfigurationRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutBucketInventoryConfigurationRequest.Builder,PutBucketInventoryConfigurationRequest>

  • Method Details

    • bucket

      PutBucketInventoryConfigurationRequest.Builder bucket(String bucket)

      The name of the bucket where the inventory configuration will be stored.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

      Parameters:
      bucket - The name of the bucket where the inventory configuration will be stored.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      PutBucketInventoryConfigurationRequest.Builder id(String id)

      The ID used to identify the inventory configuration.

      Parameters:
      id - The ID used to identify the inventory configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inventoryConfiguration

      PutBucketInventoryConfigurationRequest.Builder inventoryConfiguration(InventoryConfiguration inventoryConfiguration)

      Specifies the inventory configuration.

      Parameters:
      inventoryConfiguration - Specifies the inventory configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inventoryConfiguration

      default PutBucketInventoryConfigurationRequest.Builder inventoryConfiguration(Consumer<InventoryConfiguration.Builder> inventoryConfiguration)

      Specifies the inventory configuration.

      This is a convenience method that creates an instance of the InventoryConfiguration.Builder avoiding the need to create one manually via InventoryConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inventoryConfiguration(InventoryConfiguration).

      Parameters:
      inventoryConfiguration - a consumer that will call methods on InventoryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      PutBucketInventoryConfigurationRequest.Builder expectedBucketOwner(String expectedBucketOwner)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

      Parameters:
      expectedBucketOwner - The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutBucketInventoryConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutBucketInventoryConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.