public static interface GlobalSecondaryIndex.Builder extends SdkPojo, CopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>
Modifier and Type | Method and Description |
---|---|
GlobalSecondaryIndex.Builder |
indexName(String indexName)
The name of the global secondary index.
|
GlobalSecondaryIndex.Builder |
keySchema(Collection<KeySchemaElement> keySchema)
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names
and key types:
|
GlobalSecondaryIndex.Builder |
keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names
and key types:
|
GlobalSecondaryIndex.Builder |
keySchema(KeySchemaElement... keySchema)
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names
and key types:
|
default GlobalSecondaryIndex.Builder |
projection(Consumer<Projection.Builder> projection)
Represents attributes that are copied (projected) from the table into the global secondary index.
|
GlobalSecondaryIndex.Builder |
projection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary index.
|
default GlobalSecondaryIndex.Builder |
provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
GlobalSecondaryIndex.Builder |
provisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
GlobalSecondaryIndex.Builder indexName(String indexName)
The name of the global secondary index. The name must be unique among all other indexes on this table.
indexName
- The name of the global secondary index. The name must be unique among all other indexes on this table.GlobalSecondaryIndex.Builder keySchema(Collection<KeySchemaElement> keySchema)
The complete key schema for a global secondary index, which consists 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.
keySchema
- The complete key schema for a global secondary index, which consists 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.
GlobalSecondaryIndex.Builder keySchema(KeySchemaElement... keySchema)
The complete key schema for a global secondary index, which consists 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.
keySchema
- The complete key schema for a global secondary index, which consists 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.
GlobalSecondaryIndex.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The complete key schema for a global secondary index, which consists 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 via KeySchemaElement.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately
and its result is passed to #keySchema(List
.
keySchema
- a consumer that will call methods on
KeySchemaElement.Builder
#keySchema(java.util.Collection)
GlobalSecondaryIndex.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.
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.default GlobalSecondaryIndex.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 method that creates an instance of theProjection.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)
.
projection
- a consumer that will call methods on Projection.Builder
projection(Projection)
GlobalSecondaryIndex.Builder provisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
default GlobalSecondaryIndex.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
This is a convenience method that creates an instance of theProvisionedThroughput.Builder
avoiding
the need to create one manually via ProvisionedThroughput.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to provisionedThroughput(ProvisionedThroughput)
.
provisionedThroughput
- a consumer that will call methods on ProvisionedThroughput.Builder
provisionedThroughput(ProvisionedThroughput)
Copyright © 2023. All rights reserved.