Struct aws_sdk_dynamodb::types::LocalSecondaryIndexInfo
source · #[non_exhaustive]pub struct LocalSecondaryIndexInfo {
pub index_name: Option<String>,
pub key_schema: Option<Vec<KeySchemaElement>>,
pub projection: Option<Projection>,
}
Expand description
Represents the properties of a local secondary index for the table when the backup was created.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.index_name: Option<String>
Represents the name of the local secondary index.
key_schema: Option<Vec<KeySchemaElement>>
The complete key schema for a local 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.
projection: 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.
Implementations§
source§impl LocalSecondaryIndexInfo
impl LocalSecondaryIndexInfo
sourcepub fn index_name(&self) -> Option<&str>
pub fn index_name(&self) -> Option<&str>
Represents the name of the local secondary index.
sourcepub fn key_schema(&self) -> &[KeySchemaElement]
pub fn key_schema(&self) -> &[KeySchemaElement]
The complete key schema for a local 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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .key_schema.is_none()
.
sourcepub fn projection(&self) -> Option<&Projection>
pub fn 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.
source§impl LocalSecondaryIndexInfo
impl LocalSecondaryIndexInfo
sourcepub fn builder() -> LocalSecondaryIndexInfoBuilder
pub fn builder() -> LocalSecondaryIndexInfoBuilder
Creates a new builder-style object to manufacture LocalSecondaryIndexInfo
.
Trait Implementations§
source§impl Clone for LocalSecondaryIndexInfo
impl Clone for LocalSecondaryIndexInfo
source§fn clone(&self) -> LocalSecondaryIndexInfo
fn clone(&self) -> LocalSecondaryIndexInfo
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LocalSecondaryIndexInfo
impl Debug for LocalSecondaryIndexInfo
source§impl PartialEq for LocalSecondaryIndexInfo
impl PartialEq for LocalSecondaryIndexInfo
source§fn eq(&self, other: &LocalSecondaryIndexInfo) -> bool
fn eq(&self, other: &LocalSecondaryIndexInfo) -> bool
self
and other
values to be equal, and is used
by ==
.