software.amazon.awssdk.services.clouddirectory.model

Class ListIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest

software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListIndexRequest
extends CloudDirectoryRequest
implements ToCopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListIndexRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListIndexRequest.Builder	builder()
ConsistencyLevel	consistencyLevel() The consistency level to execute the request at.
String	consistencyLevelAsString() The consistency level to execute the request at.
String	directoryArn() The ARN of the directory that the index exists in.
boolean	equals(Object obj)
<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()
ObjectReference	indexReference() The reference to the index to list.
Integer	maxResults() The maximum number of objects in a single page to retrieve from the index during a request.
String	nextToken() The pagination token.
List<ObjectAttributeRange>	rangesOnIndexedValues() Specifies the ranges of indexed values that you want to query.
List<SdkField<?>>	sdkFields()
static Class<? extends ListIndexRequest.Builder>	serializableBuilderClass()
ListIndexRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

directoryArn

public String directoryArn()

The ARN of the directory that the index exists in.

Returns:

The ARN of the directory that the index exists in.

rangesOnIndexedValues

public List<ObjectAttributeRange> rangesOnIndexedValues()

Specifies the ranges of indexed values that you want to query.

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

Returns:

Specifies the ranges of indexed values that you want to query.

indexReference

public ObjectReference indexReference()

The reference to the index to list.

Returns:

The reference to the index to list.

maxResults

public Integer maxResults()

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

Returns:

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

nextToken

public String nextToken()

The pagination token.

Returns:

The pagination token.

consistencyLevel

public ConsistencyLevel consistencyLevel()

The consistency level to execute the request at.

If the service returns an enum value that is not available in the current SDK version, consistencyLevel will return ConsistencyLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consistencyLevelAsString().

Returns:

The consistency level to execute the request at.

See Also:

ConsistencyLevel

consistencyLevelAsString

public String consistencyLevelAsString()

The consistency level to execute the request at.

If the service returns an enum value that is not available in the current SDK version, consistencyLevel will return ConsistencyLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consistencyLevelAsString().

Returns:

The consistency level to execute the request at.

See Also:

ConsistencyLevel

toBuilder

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

Specified by:

toBuilder in class CloudDirectoryRequest

Returns:

a builder for type T

builder

public static ListIndexRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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