@Generated(value="com.ibm.cos.v2:codegen") public final class ListBucketsRequest extends S3Request implements ToCopyableBuilder<ListBucketsRequest.Builder,ListBucketsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListBucketsRequest.Builder |
| Modifier and Type | Method and 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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
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.
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.
public final String prefix()
Limits the response to bucket names that begin with the specified bucket name prefix.
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.
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.
public ListBucketsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ListBucketsRequest.Builder,ListBucketsRequest>toBuilder in class S3Requestpublic static ListBucketsRequest.Builder builder()
public static Class<? extends ListBucketsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestpublic final Map<String,SdkField<?>> sdkFieldNameToField()
sdkFieldNameToField in interface SdkPojoCopyright © 2026. All rights reserved.