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

Class ListBucketsExtendedRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBucketsExtendedRequest.Builder,ListBucketsExtendedRequest>

public class ListBucketsExtendedRequest
extends S3Request
implements SdkPojo, ToCopyableBuilder<ListBucketsExtendedRequest.Builder,ListBucketsExtendedRequest>

Request to retrieve a listing of buckets from Cloud Object Storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListBucketsExtendedRequest.Builder

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListBucketsExtendedRequest.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 SdkRequest.
int	hashCode()
String	marker() Gets the optional marker parameter indicating where in the bucket to begin listing.
Integer	maxKeys() Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
String	prefix() Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix.
List<SdkField<?>>	sdkFields()
ListBucketsExtendedRequest.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.core.SdkPojo

sdkFieldNameToField

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

copy

Field Detail

SDK_FIELDS

public static final List<SdkField<?>> SDK_FIELDS

Constructor Detail

ListBucketsExtendedRequest

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

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

Method Detail

maxKeys

public Integer maxKeys()

Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response. COS S3 might return fewer keys than specified, but will never return more.

Returns:

The optional parameter indicating the maximum number of keys to include in the response.

See Also:

(String)

prefix

public String prefix()

Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

Returns:

The optional prefix parameter restricting the response to keys that begin with the specified prefix.

See Also:

(String)

marker

public String marker()

Gets the optional marker parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

Returns:

The optional marker parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

See Also:

(String)

toBuilder

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

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static ListBucketsExtendedRequest.Builder builder()

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