Interface PutBucketMetricsConfigurationRequest.Builder

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

  • Method Details

    • bucket

      PutBucketMetricsConfigurationRequest.Builder bucket(String bucket)

      The name of the bucket for which the metrics configuration is set.

      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 for which the metrics configuration is set.

      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

      PutBucketMetricsConfigurationRequest.Builder id(String id)

      The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

      Parameters:
      id - The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricsConfiguration

      PutBucketMetricsConfigurationRequest.Builder metricsConfiguration(MetricsConfiguration metricsConfiguration)

      Specifies the metrics configuration.

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

    • metricsConfiguration

      default PutBucketMetricsConfigurationRequest.Builder metricsConfiguration(Consumer<MetricsConfiguration.Builder> metricsConfiguration)

      Specifies the metrics configuration.

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

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

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

    • expectedBucketOwner

      PutBucketMetricsConfigurationRequest.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

      PutBucketMetricsConfigurationRequest.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

      PutBucketMetricsConfigurationRequest.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.