Package software.amazon.awssdk.services.s3.model

Interface ListBucketMetricsConfigurationsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListBucketMetricsConfigurationsRequest.Builder,ListBucketMetricsConfigurationsRequest>, S3Request.Builder, SdkBuilder<ListBucketMetricsConfigurationsRequest.Builder,ListBucketMetricsConfigurationsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListBucketMetricsConfigurationsRequest

@Mutable
@NotThreadSafe
public static interface ListBucketMetricsConfigurationsRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<ListBucketMetricsConfigurationsRequest.Builder,ListBucketMetricsConfigurationsRequest>

Method Summary

Modifier and Type	Method	Description
ListBucketMetricsConfigurationsRequest.Builder	bucket(String bucket)	The name of the bucket containing the metrics configurations to retrieve.
ListBucketMetricsConfigurationsRequest.Builder	continuationToken(String continuationToken)	The marker that is used to continue a metrics configuration listing that has been truncated.
ListBucketMetricsConfigurationsRequest.Builder	expectedBucketOwner(String expectedBucketOwner)	The account ID of the expected bucket owner.
ListBucketMetricsConfigurationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListBucketMetricsConfigurationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

bucket

ListBucketMetricsConfigurationsRequest.Builder bucket(String bucket)

The name of the bucket containing the metrics configurations to retrieve.

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 containing the metrics configurations to retrieve.

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.

continuationToken

ListBucketMetricsConfigurationsRequest.Builder continuationToken(String continuationToken)

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Parameters:

continuationToken - The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Returns:

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

expectedBucketOwner

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

ListBucketMetricsConfigurationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListBucketMetricsConfigurationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder