/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace DynamoDB { namespace Model { /** *

Represents the properties of a local secondary index.

See * Also:

AWS * API Reference

*/ class LocalSecondaryIndexDescription { public: AWS_DYNAMODB_API LocalSecondaryIndexDescription(); AWS_DYNAMODB_API LocalSecondaryIndexDescription(Aws::Utils::Json::JsonView jsonValue); AWS_DYNAMODB_API LocalSecondaryIndexDescription& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_DYNAMODB_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

Represents the name of the local secondary index.

*/ inline const Aws::String& GetIndexName() const{ return m_indexName; } /** *

Represents the name of the local secondary index.

*/ inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; } /** *

Represents the name of the local secondary index.

*/ inline void SetIndexName(const Aws::String& value) { m_indexNameHasBeenSet = true; m_indexName = value; } /** *

Represents the name of the local secondary index.

*/ inline void SetIndexName(Aws::String&& value) { m_indexNameHasBeenSet = true; m_indexName = std::move(value); } /** *

Represents the name of the local secondary index.

*/ inline void SetIndexName(const char* value) { m_indexNameHasBeenSet = true; m_indexName.assign(value); } /** *

Represents the name of the local secondary index.

*/ inline LocalSecondaryIndexDescription& WithIndexName(const Aws::String& value) { SetIndexName(value); return *this;} /** *

Represents the name of the local secondary index.

*/ inline LocalSecondaryIndexDescription& WithIndexName(Aws::String&& value) { SetIndexName(std::move(value)); return *this;} /** *

Represents the name of the local secondary index.

*/ inline LocalSecondaryIndexDescription& WithIndexName(const char* value) { SetIndexName(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetKeySchema() const{ return m_keySchema; } /** *

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.

*/ inline bool KeySchemaHasBeenSet() const { return m_keySchemaHasBeenSet; } /** *

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.

*/ inline void SetKeySchema(const Aws::Vector& value) { m_keySchemaHasBeenSet = true; m_keySchema = value; } /** *

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.

*/ inline void SetKeySchema(Aws::Vector&& value) { m_keySchemaHasBeenSet = true; m_keySchema = std::move(value); } /** *

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.

*/ inline LocalSecondaryIndexDescription& WithKeySchema(const Aws::Vector& value) { SetKeySchema(value); return *this;} /** *

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.

*/ inline LocalSecondaryIndexDescription& WithKeySchema(Aws::Vector&& value) { SetKeySchema(std::move(value)); return *this;} /** *

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.

*/ inline LocalSecondaryIndexDescription& AddKeySchema(const KeySchemaElement& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(value); return *this; } /** *

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.

*/ inline LocalSecondaryIndexDescription& AddKeySchema(KeySchemaElement&& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const Projection& GetProjection() const{ return m_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.

*/ inline bool ProjectionHasBeenSet() const { return m_projectionHasBeenSet; } /** *

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.

*/ inline void SetProjection(const Projection& value) { m_projectionHasBeenSet = true; m_projection = value; } /** *

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.

*/ inline void SetProjection(Projection&& value) { m_projectionHasBeenSet = true; m_projection = std::move(value); } /** *

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.

*/ inline LocalSecondaryIndexDescription& WithProjection(const Projection& value) { SetProjection(value); return *this;} /** *

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.

*/ inline LocalSecondaryIndexDescription& WithProjection(Projection&& value) { SetProjection(std::move(value)); return *this;} /** *

The total size of the specified index, in bytes. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline long long GetIndexSizeBytes() const{ return m_indexSizeBytes; } /** *

The total size of the specified index, in bytes. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline bool IndexSizeBytesHasBeenSet() const { return m_indexSizeBytesHasBeenSet; } /** *

The total size of the specified index, in bytes. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline void SetIndexSizeBytes(long long value) { m_indexSizeBytesHasBeenSet = true; m_indexSizeBytes = value; } /** *

The total size of the specified index, in bytes. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline LocalSecondaryIndexDescription& WithIndexSizeBytes(long long value) { SetIndexSizeBytes(value); return *this;} /** *

The number of items in the specified index. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline long long GetItemCount() const{ return m_itemCount; } /** *

The number of items in the specified index. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline bool ItemCountHasBeenSet() const { return m_itemCountHasBeenSet; } /** *

The number of items in the specified index. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline void SetItemCount(long long value) { m_itemCountHasBeenSet = true; m_itemCount = value; } /** *

The number of items in the specified index. DynamoDB updates this value * approximately every six hours. Recent changes might not be reflected in this * value.

*/ inline LocalSecondaryIndexDescription& WithItemCount(long long value) { SetItemCount(value); return *this;} /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline const Aws::String& GetIndexArn() const{ return m_indexArn; } /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline bool IndexArnHasBeenSet() const { return m_indexArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline void SetIndexArn(const Aws::String& value) { m_indexArnHasBeenSet = true; m_indexArn = value; } /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline void SetIndexArn(Aws::String&& value) { m_indexArnHasBeenSet = true; m_indexArn = std::move(value); } /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline void SetIndexArn(const char* value) { m_indexArnHasBeenSet = true; m_indexArn.assign(value); } /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline LocalSecondaryIndexDescription& WithIndexArn(const Aws::String& value) { SetIndexArn(value); return *this;} /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline LocalSecondaryIndexDescription& WithIndexArn(Aws::String&& value) { SetIndexArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ inline LocalSecondaryIndexDescription& WithIndexArn(const char* value) { SetIndexArn(value); return *this;} private: Aws::String m_indexName; bool m_indexNameHasBeenSet = false; Aws::Vector m_keySchema; bool m_keySchemaHasBeenSet = false; Projection m_projection; bool m_projectionHasBeenSet = false; long long m_indexSizeBytes; bool m_indexSizeBytesHasBeenSet = false; long long m_itemCount; bool m_itemCountHasBeenSet = false; Aws::String m_indexArn; bool m_indexArnHasBeenSet = false; }; } // namespace Model } // namespace DynamoDB } // namespace Aws