Package software.amazon.awssdk.services.dynamodb.model

Interface LocalSecondaryIndex.Builder

    • Method Detail

      • indexName

        LocalSecondaryIndex.Builder indexName​(String indexName)

        The name of the local secondary index. The name must be unique among all other indexes on this table.

        Parameters:
        indexName - The name of the local secondary index. The name must be unique among all other indexes on this table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keySchema

        LocalSecondaryIndex.Builder keySchema​(Collection<KeySchemaElement> keySchema)

        The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

        The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        Parameters:
        keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

        The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keySchema

        LocalSecondaryIndex.Builder keySchema​(KeySchemaElement... keySchema)

        The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

        The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        Parameters:
        keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

        The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keySchema

        LocalSecondaryIndex.Builder keySchema​(Consumer<KeySchemaElement.Builder>... keySchema)

        The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

        The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        This is a convenience method that creates an instance of the KeySchemaElement.Builder avoiding the need to create one manually via KeySchemaElement.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #keySchema(List).

        Parameters:
        keySchema - a consumer that will call methods on KeySchemaElement.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #keySchema(java.util.Collection)

      • projection

        LocalSecondaryIndex.Builder projection​(Projection projection)

        Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

        Parameters:
        projection - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.