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

Class ListDirectoryBucketsRequest

java.lang.Object

com.ibm.cos.v2.core.SdkRequest

com.ibm.cos.v2.awscore.AwsRequest

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDirectoryBucketsRequest.Builder,ListDirectoryBucketsRequest>

@Generated(value="com.ibm.cos.v2:codegen")
public final class ListDirectoryBucketsRequest
extends S3Request
implements ToCopyableBuilder<ListDirectoryBucketsRequest.Builder,ListDirectoryBucketsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListDirectoryBucketsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListDirectoryBucketsRequest.Builder	builder()
String	continuationToken() ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token.
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 SdkRequest.
int	hashCode()
Integer	maxDirectoryBuckets() Maximum number of buckets to be returned in response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListDirectoryBucketsRequest.Builder>	serializableBuilderClass()
ListDirectoryBucketsRequest.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.awscore.AwsRequest

overrideConfiguration

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

Method Detail

continuationToken

public final String continuationToken()

ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.

Returns:

ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.

maxDirectoryBuckets

public final Integer maxDirectoryBuckets()

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.

toBuilder

public ListDirectoryBucketsRequest.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<ListDirectoryBucketsRequest.Builder,ListDirectoryBucketsRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static ListDirectoryBucketsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListDirectoryBucketsRequest.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)

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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.