255 lines
12 KiB
C++
255 lines
12 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/dynamodb/DynamoDB_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/dynamodb/model/Projection.h>
|
|
#include <aws/dynamodb/model/KeySchemaElement.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace DynamoDB
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Represents the properties of a local secondary index for the table when the
|
|
* backup was created.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/LocalSecondaryIndexInfo">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_DYNAMODB_API LocalSecondaryIndexInfo
|
|
{
|
|
public:
|
|
LocalSecondaryIndexInfo();
|
|
LocalSecondaryIndexInfo(Aws::Utils::Json::JsonView jsonValue);
|
|
LocalSecondaryIndexInfo& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline const Aws::String& GetIndexName() const{ return m_indexName; }
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline void SetIndexName(const Aws::String& value) { m_indexNameHasBeenSet = true; m_indexName = value; }
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline void SetIndexName(Aws::String&& value) { m_indexNameHasBeenSet = true; m_indexName = std::move(value); }
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline void SetIndexName(const char* value) { m_indexNameHasBeenSet = true; m_indexName.assign(value); }
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithIndexName(const Aws::String& value) { SetIndexName(value); return *this;}
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithIndexName(Aws::String&& value) { SetIndexName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Represents the name of the local secondary index.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithIndexName(const char* value) { SetIndexName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline const Aws::Vector<KeySchemaElement>& GetKeySchema() const{ return m_keySchema; }
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline bool KeySchemaHasBeenSet() const { return m_keySchemaHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline void SetKeySchema(const Aws::Vector<KeySchemaElement>& value) { m_keySchemaHasBeenSet = true; m_keySchema = value; }
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline void SetKeySchema(Aws::Vector<KeySchemaElement>&& value) { m_keySchemaHasBeenSet = true; m_keySchema = std::move(value); }
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithKeySchema(const Aws::Vector<KeySchemaElement>& value) { SetKeySchema(value); return *this;}
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithKeySchema(Aws::Vector<KeySchemaElement>&& value) { SetKeySchema(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& AddKeySchema(const KeySchemaElement& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The complete key schema for a local secondary index, which consists of one or
|
|
* more pairs of attribute names and key types:</p> <ul> <li> <p> <code>HASH</code>
|
|
* - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul>
|
|
* <p>The partition key of an item is also known as its <i>hash
|
|
* attribute</i>. 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.</p> <p>The sort key of an item is also known as
|
|
* its <i>range attribute</i>. 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.</p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& AddKeySchema(KeySchemaElement&& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline const Projection& GetProjection() const{ return m_projection; }
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline bool ProjectionHasBeenSet() const { return m_projectionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline void SetProjection(const Projection& value) { m_projectionHasBeenSet = true; m_projection = value; }
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline void SetProjection(Projection&& value) { m_projectionHasBeenSet = true; m_projection = std::move(value); }
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithProjection(const Projection& value) { SetProjection(value); return *this;}
|
|
|
|
/**
|
|
* <p>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. </p>
|
|
*/
|
|
inline LocalSecondaryIndexInfo& WithProjection(Projection&& value) { SetProjection(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_indexName;
|
|
bool m_indexNameHasBeenSet;
|
|
|
|
Aws::Vector<KeySchemaElement> m_keySchema;
|
|
bool m_keySchemaHasBeenSet;
|
|
|
|
Projection m_projection;
|
|
bool m_projectionHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace DynamoDB
|
|
} // namespace Aws
|