#[non_exhaustive]pub struct LocalSecondaryIndexBuilder { /* private fields */ }
Expand description
A builder for LocalSecondaryIndex
.
Implementations§
source§impl LocalSecondaryIndexBuilder
impl LocalSecondaryIndexBuilder
sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The name of the local secondary index. The name must be unique among all other indexes on this table.
This field is required.sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The name of the local secondary index. The name must be unique among all other indexes on this table.
sourcepub fn get_index_name(&self) -> &Option<String>
pub fn get_index_name(&self) -> &Option<String>
The name of the local secondary index. The name must be unique among all other indexes on this table.
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 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.
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 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.
sourcepub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
pub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
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.
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 local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
This field is required.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 local 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 local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
sourcepub fn build(self) -> Result<LocalSecondaryIndex, BuildError>
pub fn build(self) -> Result<LocalSecondaryIndex, BuildError>
Consumes the builder and constructs a LocalSecondaryIndex
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for LocalSecondaryIndexBuilder
impl Clone for LocalSecondaryIndexBuilder
source§fn clone(&self) -> LocalSecondaryIndexBuilder
fn clone(&self) -> LocalSecondaryIndexBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LocalSecondaryIndexBuilder
impl Debug for LocalSecondaryIndexBuilder
source§impl Default for LocalSecondaryIndexBuilder
impl Default for LocalSecondaryIndexBuilder
source§fn default() -> LocalSecondaryIndexBuilder
fn default() -> LocalSecondaryIndexBuilder
source§impl PartialEq for LocalSecondaryIndexBuilder
impl PartialEq for LocalSecondaryIndexBuilder
source§fn eq(&self, other: &LocalSecondaryIndexBuilder) -> bool
fn eq(&self, other: &LocalSecondaryIndexBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.