Struct LocalSecondaryIndexBuilder

#[non_exhaustive]
pub struct LocalSecondaryIndexBuilder { /* private fields */ }

A builder for LocalSecondaryIndex.

Implementations

impl LocalSecondaryIndexBuilder

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.

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.

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.

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.

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.

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.

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.

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.

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.

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:

• index_name
• key_schema

Trait Implementations

impl Clone for LocalSecondaryIndexBuilder

fn clone(&self) -> LocalSecondaryIndexBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalSecondaryIndexBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LocalSecondaryIndexBuilder

fn default() -> LocalSecondaryIndexBuilder

Returns the “default value” for a type.

impl PartialEq for LocalSecondaryIndexBuilder

fn eq(&self, other: &LocalSecondaryIndexBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LocalSecondaryIndexBuilder