software.amazon.awssdk.enhanced.dynamodb.internal.client

Class DefaultDynamoDbAsyncIndex<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbAsyncIndex<T>

All Implemented Interfaces:

DynamoDbAsyncIndex<T>

public final class DefaultDynamoDbAsyncIndex<T>
extends Object
implements DynamoDbAsyncIndex<T>

Method Summary

Modifier and Type	Method and Description
DynamoDbAsyncClient	dynamoDbClient()
boolean	equals(Object o)
int	hashCode()
String	indexName() Gets the physical secondary index name that operations performed by this object will be executed against.
Key	keyFrom(T item) Creates a Key object from a modelled item.
DynamoDbEnhancedClientExtension	mapperExtension() Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.
SdkPublisher<Page<T>>	query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)
SdkPublisher<Page<T>>	query(QueryEnhancedRequest request)
SdkPublisher<Page<T>>	scan()
SdkPublisher<Page<T>>	scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)
SdkPublisher<Page<T>>	scan(ScanEnhancedRequest request)
String	tableName() Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	tableSchema() Gets the TableSchema object that this mapped table was built with.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

query

public SdkPublisher<Page<T>> query(QueryEnhancedRequest request)

Specified by:

query in interface DynamoDbAsyncIndex<T>

query

public SdkPublisher<Page<T>> query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)

Specified by:

query in interface DynamoDbAsyncIndex<T>

scan

public SdkPublisher<Page<T>> scan(ScanEnhancedRequest request)

Specified by:

scan in interface DynamoDbAsyncIndex<T>

scan

public SdkPublisher<Page<T>> scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)

Specified by:

scan in interface DynamoDbAsyncIndex<T>

scan

public SdkPublisher<Page<T>> scan()

Specified by:

scan in interface DynamoDbAsyncIndex<T>

mapperExtension

public DynamoDbEnhancedClientExtension mapperExtension()

Description copied from interface: DynamoDbAsyncIndex

Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.

Specified by:

mapperExtension in interface DynamoDbAsyncIndex<T>

Returns:

The DynamoDbEnhancedClientExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: DynamoDbAsyncIndex

Gets the TableSchema object that this mapped table was built with.

Specified by:

tableSchema in interface DynamoDbAsyncIndex<T>

Returns:

The TableSchema object for this mapped table.

dynamoDbClient

public DynamoDbAsyncClient dynamoDbClient()

tableName

public String tableName()

Description copied from interface: DynamoDbAsyncIndex

Gets the physical table name that operations performed by this object will be executed against.

Specified by:

tableName in interface DynamoDbAsyncIndex<T>

Returns:

The physical table name.

indexName

public String indexName()

Description copied from interface: DynamoDbAsyncIndex

Gets the physical secondary index name that operations performed by this object will be executed against.

Specified by:

indexName in interface DynamoDbAsyncIndex<T>

Returns:

The physical secondary index name.

keyFrom

public Key keyFrom(T item)

Description copied from interface: DynamoDbAsyncIndex

Creates a Key object from a modelled item. This key can be used in query conditionals and get operations to locate a specific record.

Specified by:

keyFrom in interface DynamoDbAsyncIndex<T>

Parameters:

item - The item to extract the key fields from.

Returns:

A key that has been initialized with the index values extracted from the modelled object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object