Package 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("software.amazon.awssdk:codegen")
public final class ListIndexRequest
extends CloudDirectoryRequest
implements ToCopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListIndexRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRangesOnIndexedValues()	For responses, this returns true if the service returned a value for the RangesOnIndexedValues property.
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()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

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

directoryArn

public final String directoryArn()

The ARN of the directory that the index exists in.

Returns:

The ARN of the directory that the index exists in.

hasRangesOnIndexedValues

public final boolean hasRangesOnIndexedValues()

For responses, this returns true if the service returned a value for the RangesOnIndexedValues 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.

rangesOnIndexedValues

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

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 hasRangesOnIndexedValues() method.

Returns:

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

indexReference

public final ObjectReference indexReference()

The reference to the index to list.

Returns:

The reference to the index to list.

maxResults

public final 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 final String nextToken()

The pagination token.

Returns:

The pagination token.

consistencyLevel

public final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

builder

public static ListIndexRequest.Builder builder()

serializableBuilderClass

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

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo