commonMain.aws.sdk.kotlin.hll.dynamodbmapper.model.IndexSpec.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dynamodb-mapper-jvm Show documentation

High level DynamoDbMapper client

There is a newer version: 1.3.99-beta

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.sdk.kotlin.hll.dynamodbmapper.model

import aws.sdk.kotlin.hll.dynamodbmapper.items.ItemSchema
import aws.smithy.kotlin.runtime.ExperimentalApi

/**
 * Specifies how items can be read from a secondary index
 * @param T The type of objects which will be read from this index
 */
@ExperimentalApi
public interface IndexSpec : PersistenceSpec {
    /**
     * The name of the table
     */
    public val tableName: String

    /**
     * The name of the secondary index
     */
    public val indexName: String?

    /**
     * Specifies how items can be read from a secondary index whose primary key consists of a single partition key
     */
    @ExperimentalApi
    public interface PartitionKey : IndexSpec {
        override val schema: ItemSchema.PartitionKey
    }

    /**
     * Specifies how items can be read from a secondary index whose primary key consists of a composite of a partition
     * key and a sort key
     */
    @ExperimentalApi
    public interface CompositeKey : IndexSpec {
        override val schema: ItemSchema.CompositeKey
    }
}