software.amazon.awssdk.services.dynamodb.model

Interface LocalSecondaryIndexDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LocalSecondaryIndexDescription.Builder,LocalSecondaryIndexDescription>, SdkBuilder<LocalSecondaryIndexDescription.Builder,LocalSecondaryIndexDescription>, SdkPojo

Enclosing class:

LocalSecondaryIndexDescription

public static interface LocalSecondaryIndexDescription.Builder
extends SdkPojo, CopyableBuilder<LocalSecondaryIndexDescription.Builder,LocalSecondaryIndexDescription>

Method Summary

Modifier and Type	Method and Description
LocalSecondaryIndexDescription.Builder	indexArn(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.
LocalSecondaryIndexDescription.Builder	indexName(String indexName) Represents the name of the local secondary index.
LocalSecondaryIndexDescription.Builder	indexSizeBytes(Long indexSizeBytes) The total size of the specified index, in bytes.
LocalSecondaryIndexDescription.Builder	itemCount(Long itemCount) The number of items in the specified index.
LocalSecondaryIndexDescription.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:
LocalSecondaryIndexDescription.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:
LocalSecondaryIndexDescription.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:
default LocalSecondaryIndexDescription.Builder	projection(Consumer<Projection.Builder> projection) Represents attributes that are copied (projected) from the table into the global secondary index.
LocalSecondaryIndexDescription.Builder	projection(Projection projection) Represents attributes that are copied (projected) from the table into the global secondary index.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

indexName

LocalSecondaryIndexDescription.Builder indexName(String indexName)

Represents the name of the local secondary index.

Parameters:

indexName - Represents the name of the local secondary index.

Returns:

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

keySchema

LocalSecondaryIndexDescription.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

LocalSecondaryIndexDescription.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

LocalSecondaryIndexDescription.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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #keySchema(List).

Parameters:

keySchema - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#keySchema(List)

projection

LocalSecondaryIndexDescription.Builder projection(Projection projection)

Represents attributes that are copied (projected) from the table into the global 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 global 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.

projection

default LocalSecondaryIndexDescription.Builder projection(Consumer<Projection.Builder> projection)

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

This is a convenience that creates an instance of the Projection.Builder avoiding the need to create one manually via Projection.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to projection(Projection).

Parameters:

projection - a consumer that will call methods on Projection.Builder

Returns:

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

See Also:

projection(Projection)

indexSizeBytes

LocalSecondaryIndexDescription.Builder indexSizeBytes(Long indexSizeBytes)

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Parameters:

indexSizeBytes - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

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

itemCount

LocalSecondaryIndexDescription.Builder itemCount(Long itemCount)

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Parameters:

itemCount - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

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

indexArn

LocalSecondaryIndexDescription.Builder indexArn(String indexArn)

The Amazon Resource Name (ARN) that uniquely identifies the index.

Parameters:

indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.

Returns:

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