Interface GlobalSecondaryIndexInfo.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GlobalSecondaryIndexInfo.Builder,
,GlobalSecondaryIndexInfo> SdkBuilder<GlobalSecondaryIndexInfo.Builder,
,GlobalSecondaryIndexInfo> SdkPojo
- Enclosing class:
GlobalSecondaryIndexInfo
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the global secondary index.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: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: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 GlobalSecondaryIndexInfo.Builder
onDemandThroughput
(Consumer<OnDemandThroughput.Builder> onDemandThroughput) Sets the value of the OnDemandThroughput property for this object.onDemandThroughput
(OnDemandThroughput onDemandThroughput) Sets the value of the OnDemandThroughput property for this object.default GlobalSecondaryIndexInfo.Builder
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.default GlobalSecondaryIndexInfo.Builder
provisionedThroughput
(Consumer<ProvisionedThroughput.Builder> provisionedThroughput) Represents the provisioned throughput settings for the specified global secondary index.provisionedThroughput
(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for the specified 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
The name of the global secondary index.
- Parameters:
indexName
- The name of the global secondary index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 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:
-
provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
- Parameters:
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
default GlobalSecondaryIndexInfo.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput) Represents the provisioned throughput settings for the specified global secondary index.
This is a convenience method that creates an instance of theProvisionedThroughput.Builder
avoiding the need to create one manually viaProvisionedThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedThroughput(ProvisionedThroughput)
.- Parameters:
provisionedThroughput
- a consumer that will call methods onProvisionedThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
onDemandThroughput
Sets the value of the OnDemandThroughput property for this object.- Parameters:
onDemandThroughput
- The new value for the OnDemandThroughput property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
onDemandThroughput
default GlobalSecondaryIndexInfo.Builder onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput) Sets the value of the OnDemandThroughput property for this object. This is a convenience method that creates an instance of theOnDemandThroughput.Builder
avoiding the need to create one manually viaOnDemandThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toonDemandThroughput(OnDemandThroughput)
.- Parameters:
onDemandThroughput
- a consumer that will call methods onOnDemandThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-