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

Class ListBucketsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.s3.model.S3Response

software.amazon.awssdk.services.s3.model.ListBucketsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBucketsResponse.Builder,ListBucketsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBucketsResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<Bucket>	buckets()	The list of buckets owned by the requester.
static ListBucketsResponse.Builder	builder()
String	continuationToken()	ContinuationToken is included in the response when there are more buckets that can be listed with pagination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBuckets()	For responses, this returns true if the service returned a value for the Buckets property.
int	hashCode()
Owner	owner()	The owner of the buckets listed.
String	prefix()	If Prefix was sent with the request, it is included in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListBucketsResponse.Builder>	serializableBuilderClass()
ListBucketsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasBuckets

public final boolean hasBuckets()

For responses, this returns true if the service returned a value for the Buckets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

buckets

public final List<Bucket> buckets()

The list of buckets owned by the requester.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBuckets() method.

Returns:

The list of buckets owned by the requester.

owner

public final Owner owner()

The owner of the buckets listed.

Returns:

The owner of the buckets listed.

continuationToken

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

Returns:

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.

prefix

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

Returns:

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.

toBuilder

public ListBucketsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBucketsResponse.Builder,ListBucketsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListBucketsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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