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

Class ListBucketsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3.model.S3Request

software.amazon.awssdk.services.s3.model.ListBucketsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBucketsRequest.Builder,ListBucketsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListBucketsRequest
extends S3Request
implements ToCopyableBuilder<ListBucketsRequest.Builder,ListBucketsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBucketsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketRegion()	Limits the response to buckets that are located in the specified Amazon Web Services Region.
static ListBucketsRequest.Builder	builder()
String	continuationToken()	ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxBuckets()	Maximum number of buckets to be returned in response.
String	prefix()	Limits the response to bucket names that begin with the specified bucket name prefix.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListBucketsRequest.Builder>	serializableBuilderClass()
ListBucketsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

maxBuckets

public final 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.

Returns:

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.

continuationToken

public final 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.

Returns:

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.

prefix

public final String prefix()

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

Returns:

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

bucketRegion

public final 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.

Returns:

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.

toBuilder

public ListBucketsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBucketsRequest.Builder,ListBucketsRequest>

Specified by:

toBuilder in class S3Request

builder

public static ListBucketsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListBucketsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo