com.ibm.cos.v2.services.s3.model

Interface ListBucketsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListBucketsRequest

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

Method Summary

Modifier and Type	Method and Description
ListBucketsRequest.Builder	bucketRegion(String bucketRegion) Limits the response to buckets that are located in the specified Amazon Web Services Region.
ListBucketsRequest.Builder	continuationToken(String continuationToken) ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token.
ListBucketsRequest.Builder	maxBuckets(Integer maxBuckets) Maximum number of buckets to be returned in response.
ListBucketsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListBucketsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ListBucketsRequest.Builder	prefix(String prefix) Limits the response to bucket names that begin with the specified bucket name prefix.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Request.Builder

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

maxBuckets

ListBucketsRequest.Builder maxBuckets(Integer maxBuckets)

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

Parameters:

maxBuckets - Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

Returns:

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

continuationToken

ListBucketsRequest.Builder continuationToken(String continuationToken)

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

Parameters:

continuationToken - ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

Returns:

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

prefix

ListBucketsRequest.Builder prefix(String prefix)

Limits the response to bucket names that begin with the specified bucket name prefix.

Parameters:

prefix - Limits the response to bucket names that begin with the specified bucket name prefix.

Returns:

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

bucketRegion

ListBucketsRequest.Builder bucketRegion(String bucketRegion)

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

Parameters:

bucketRegion - Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

Returns:

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

overrideConfiguration

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

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