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

Class DefaultDynamoDbIndex<T>

java.lang.Object

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

All Implemented Interfaces:

DynamoDbIndex<T>

public class DefaultDynamoDbIndex<T>
extends Object
implements DynamoDbIndex<T>

Method Summary

Modifier and Type	Method and Description
DynamoDbClient	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.
SdkIterable<Page<T>>	query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)
SdkIterable<Page<T>>	query(QueryEnhancedRequest request)
SdkIterable<Page<T>>	scan()
SdkIterable<Page<T>>	scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)
SdkIterable<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 SdkIterable<Page<T>> query(QueryEnhancedRequest request)

Specified by:

query in interface DynamoDbIndex<T>

query

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

Specified by:

query in interface DynamoDbIndex<T>

scan

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

Specified by:

scan in interface DynamoDbIndex<T>

scan

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

Specified by:

scan in interface DynamoDbIndex<T>

scan

public SdkIterable<Page<T>> scan()

Specified by:

scan in interface DynamoDbIndex<T>

mapperExtension

public DynamoDbEnhancedClientExtension mapperExtension()

Description copied from interface: DynamoDbIndex

Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.

Specified by:

mapperExtension in interface DynamoDbIndex<T>

Returns:

The DynamoDbEnhancedClientExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: DynamoDbIndex

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

Specified by:

tableSchema in interface DynamoDbIndex<T>

Returns:

The TableSchema object for this mapped table.

dynamoDbClient

public DynamoDbClient dynamoDbClient()

tableName

public String tableName()

Description copied from interface: DynamoDbIndex

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

Specified by:

tableName in interface DynamoDbIndex<T>

Returns:

The physical table name.

indexName

public String indexName()

Description copied from interface: DynamoDbIndex

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

Specified by:

indexName in interface DynamoDbIndex<T>

Returns:

The physical secondary index name.

keyFrom

public Key keyFrom(T item)

Description copied from interface: DynamoDbIndex

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