Class AsyncIndex<T>

java.lang.Object
dev.hogwai.dynamodb.simplified.async.AsyncIndex<T>
Type Parameters:
T - the item type
public class AsyncIndex<T> extends Object
Typed wrapper for an async DynamoDB secondary index (GSI or LSI).

Obtained via AsyncTable.index(String). Provides query and scan builders scoped to this index.

  • Method Details

    • getRawIndex

      public @NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbAsyncIndex<T> getRawIndex()
      Returns the underlying DynamoDbAsyncIndex.
      Returns:
      the raw async index

    • indexName

      public @NonNull String indexName()
      Returns the name of this index.
      Returns:
      the index name

    • tableName

      public @NonNull String tableName()
      Returns the name of the table this index belongs to.
      Returns:
      the table name

    • query

      public @NonNull AsyncQueryBuilder<T> query()
      Starts building an async query operation on this index.
      Returns:
      an AsyncQueryBuilder for configuring and executing the query

    • scan

      public @NonNull AsyncScanBuilder<T> scan()
      Starts building an async scan operation on this index.
      Returns:
      an AsyncScanBuilder for configuring and executing the scan