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

Class ListBucketsExtendedResponse

java.lang.Object

com.ibm.cos.v2.core.SdkResponse

com.ibm.cos.v2.awscore.AwsResponse

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBucketsExtendedResponse.Builder,ListBucketsExtendedResponse>

public class ListBucketsExtendedResponse
extends S3Response
implements ToCopyableBuilder<ListBucketsExtendedResponse.Builder,ListBucketsExtendedResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListBucketsExtendedResponse.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static List<SdkField<?>>	SDK_FIELDS

Constructor Summary

Constructors

Constructor and Description
ListBucketsExtendedResponse(com.ibm.cos.v2.services.s3.model.ListBucketsExtendedResponse.BuilderImpl builder) Constructs a new ListBucketsExtendedResponse object and initializes all required and optional object fields.

Method Summary

Modifier and Type	Method and Description
List<Bucket>	buckets()
static ListBucketsExtendedResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
Boolean	isTruncated() Gets whether or not this listing is complete.
String	marker() Parameter indicating where in the bucket to begin listing.
Owner	owner()
List<SdkField<?>>	sdkFields()
ListBucketsExtendedResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

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

sdkFieldNameToField

Field Detail

SDK_FIELDS

public static final List<SdkField<?>> SDK_FIELDS

Constructor Detail

ListBucketsExtendedResponse

public ListBucketsExtendedResponse(com.ibm.cos.v2.services.s3.model.ListBucketsExtendedResponse.BuilderImpl builder)

Constructs a new ListBucketsExtendedResponse object and initializes all required and optional object fields.

Method Detail

isTruncated

public Boolean isTruncated()

Gets whether or not this listing is complete.

Returns:

The value true if the bucket listing is not complete. Returns the value false if otherwise. When returning true, additional calls to COS may be needed in order to obtain more results.

marker

public String marker()

Parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker. This enables pagination

Returns:

marker

buckets

public List<Bucket> buckets()

owner

public Owner owner()

toBuilder

public ListBucketsExtendedResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListBucketsExtendedResponse.Builder,ListBucketsExtendedResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ListBucketsExtendedResponse.Builder builder()

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.