Interface LocalSecondaryIndexDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<LocalSecondaryIndexDescription.Builder,
,LocalSecondaryIndexDescription> SdkBuilder<LocalSecondaryIndexDescription.Builder,
,LocalSecondaryIndexDescription> SdkPojo
- Enclosing class:
LocalSecondaryIndexDescription
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) that uniquely identifies the index.Represents the name of the local secondary index.indexSizeBytes
(Long indexSizeBytes) The total size of the specified index, in bytes.The number of items in the specified index.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: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:keySchema
(KeySchemaElement... keySchema) The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:projection
(Consumer<Projection.Builder> projection) Represents attributes that are copied (projected) from the table into the global secondary index.projection
(Projection projection) Represents attributes that are copied (projected) from the table into the global secondary index.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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.
KeySchemaElement.Builder
avoiding the need to create one manually viaKeySchemaElement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokeySchema(List<KeySchemaElement>)
.- Parameters:
keySchema
- a consumer that will call methods onKeySchemaElement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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 method that creates an instance of theProjection.Builder
avoiding the need to create one manually viaProjection.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprojection(Projection)
.- Parameters:
projection
- a consumer that will call methods onProjection.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-