#[non_exhaustive]pub struct GlobalSecondaryIndexInfoBuilder { /* private fields */ }
Expand description
A builder for GlobalSecondaryIndexInfo
.
Implementations§
source§impl GlobalSecondaryIndexInfoBuilder
impl GlobalSecondaryIndexInfoBuilder
sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The name of the global secondary index.
sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The name of the global secondary index.
sourcepub fn get_index_name(&self) -> &Option<String>
pub fn get_index_name(&self) -> &Option<String>
The name of the global secondary index.
sourcepub fn key_schema(self, input: KeySchemaElement) -> Self
pub fn key_schema(self, input: KeySchemaElement) -> Self
Appends an item to key_schema
.
To override the contents of this collection use set_key_schema
.
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.
sourcepub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
pub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
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.
sourcepub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
pub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
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.
sourcepub fn projection(self, input: Projection) -> Self
pub fn projection(self, input: Projection) -> Self
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.
sourcepub fn set_projection(self, input: Option<Projection>) -> Self
pub fn set_projection(self, input: Option<Projection>) -> Self
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.
sourcepub fn get_projection(&self) -> &Option<Projection>
pub fn get_projection(&self) -> &Option<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.
sourcepub fn provisioned_throughput(self, input: ProvisionedThroughput) -> Self
pub fn provisioned_throughput(self, input: ProvisionedThroughput) -> Self
Represents the provisioned throughput settings for the specified global secondary index.
sourcepub fn set_provisioned_throughput(
self,
input: Option<ProvisionedThroughput>
) -> Self
pub fn set_provisioned_throughput( self, input: Option<ProvisionedThroughput> ) -> Self
Represents the provisioned throughput settings for the specified global secondary index.
sourcepub fn get_provisioned_throughput(&self) -> &Option<ProvisionedThroughput>
pub fn get_provisioned_throughput(&self) -> &Option<ProvisionedThroughput>
Represents the provisioned throughput settings for the specified global secondary index.
sourcepub fn build(self) -> GlobalSecondaryIndexInfo
pub fn build(self) -> GlobalSecondaryIndexInfo
Consumes the builder and constructs a GlobalSecondaryIndexInfo
.
Trait Implementations§
source§impl Clone for GlobalSecondaryIndexInfoBuilder
impl Clone for GlobalSecondaryIndexInfoBuilder
source§fn clone(&self) -> GlobalSecondaryIndexInfoBuilder
fn clone(&self) -> GlobalSecondaryIndexInfoBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GlobalSecondaryIndexInfoBuilder
impl Default for GlobalSecondaryIndexInfoBuilder
source§fn default() -> GlobalSecondaryIndexInfoBuilder
fn default() -> GlobalSecondaryIndexInfoBuilder
source§impl PartialEq for GlobalSecondaryIndexInfoBuilder
impl PartialEq for GlobalSecondaryIndexInfoBuilder
source§fn eq(&self, other: &GlobalSecondaryIndexInfoBuilder) -> bool
fn eq(&self, other: &GlobalSecondaryIndexInfoBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.