Package software.amazon.awssdk.services.clouddirectory.model

Class BatchListIndex

java.lang.Object

software.amazon.awssdk.services.clouddirectory.model.BatchListIndex

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchListIndex.Builder,BatchListIndex>

@Generated("software.amazon.awssdk:codegen")
public final class BatchListIndex
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchListIndex.Builder,BatchListIndex>

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchListIndex.Builder

Method Summary

Modifier and Type	Method	Description
static BatchListIndex.Builder	builder()
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 results to retrieve.
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 BatchListIndex.Builder>	serializableBuilderClass()
BatchListIndex.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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 results to retrieve.

Returns:

The maximum number of results to retrieve.

nextToken

public final String nextToken()

The pagination token.

Returns:

The pagination token.

toBuilder

public BatchListIndex.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchListIndex.Builder,BatchListIndex>

builder

public static BatchListIndex.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo