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

Interface ListBucketsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListBucketsResponse.Builder,ListBucketsResponse>, S3Response.Builder, SdkBuilder<ListBucketsResponse.Builder,ListBucketsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListBucketsResponse

@Mutable
@NotThreadSafe
public static interface ListBucketsResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<ListBucketsResponse.Builder,ListBucketsResponse>

Method Summary

Modifier and Type	Method	Description
ListBucketsResponse.Builder	buckets(Collection<Bucket> buckets)	The list of buckets owned by the requester.
ListBucketsResponse.Builder	buckets(Consumer<Bucket.Builder>... buckets)	The list of buckets owned by the requester.
ListBucketsResponse.Builder	buckets(Bucket... buckets)	The list of buckets owned by the requester.
ListBucketsResponse.Builder	continuationToken(String continuationToken)	ContinuationToken is included in the response when there are more buckets that can be listed with pagination.
default ListBucketsResponse.Builder	owner(Consumer<Owner.Builder> owner)	The owner of the buckets listed.
ListBucketsResponse.Builder	owner(Owner owner)	The owner of the buckets listed.
ListBucketsResponse.Builder	prefix(String prefix)	If Prefix was sent with the request, it is included in the response.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

buckets

ListBucketsResponse.Builder buckets(Collection<Bucket> buckets)

The list of buckets owned by the requester.

Parameters:

buckets - The list of buckets owned by the requester.

Returns:

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

buckets

ListBucketsResponse.Builder buckets(Bucket... buckets)

The list of buckets owned by the requester.

Parameters:

buckets - The list of buckets owned by the requester.

Returns:

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

buckets

ListBucketsResponse.Builder buckets(Consumer<Bucket.Builder>... buckets)

The list of buckets owned by the requester.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #buckets(List).

Parameters:

buckets - a consumer that will call methods on Bucket.Builder

Returns:

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

See Also:

#buckets(java.util.Collection)

owner

ListBucketsResponse.Builder owner(Owner owner)

The owner of the buckets listed.

Parameters:

owner - The owner of the buckets listed.

Returns:

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

owner

default ListBucketsResponse.Builder owner(Consumer<Owner.Builder> owner)

The owner of the buckets listed.

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

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

Parameters:

owner - a consumer that will call methods on Owner.Builder

Returns:

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

See Also:

owner(Owner)

continuationToken

ListBucketsResponse.Builder continuationToken(String continuationToken)

ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

Parameters:

continuationToken - ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

Returns:

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

prefix

ListBucketsResponse.Builder prefix(String prefix)

If Prefix was sent with the request, it is included in the response.

All bucket names in the response begin with the specified bucket name prefix.

Parameters:

prefix - If Prefix was sent with the request, it is included in the response.

All bucket names in the response begin with the specified bucket name prefix.

Returns:

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