AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::IndexConfigurationSummary Class Reference

#include <IndexConfigurationSummary.h>

Public Member Functions

 IndexConfigurationSummary ()
 
 IndexConfigurationSummary (Aws::Utils::Json::JsonView jsonValue)
 
IndexConfigurationSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
IndexConfigurationSummaryWithName (const Aws::String &value)
 
IndexConfigurationSummaryWithName (Aws::String &&value)
 
IndexConfigurationSummaryWithName (const char *value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
IndexConfigurationSummaryWithId (const Aws::String &value)
 
IndexConfigurationSummaryWithId (Aws::String &&value)
 
IndexConfigurationSummaryWithId (const char *value)
 
const IndexEditionGetEdition () const
 
bool EditionHasBeenSet () const
 
void SetEdition (const IndexEdition &value)
 
void SetEdition (IndexEdition &&value)
 
IndexConfigurationSummaryWithEdition (const IndexEdition &value)
 
IndexConfigurationSummaryWithEdition (IndexEdition &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
IndexConfigurationSummaryWithCreatedAt (const Aws::Utils::DateTime &value)
 
IndexConfigurationSummaryWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdatedAt () const
 
bool UpdatedAtHasBeenSet () const
 
void SetUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetUpdatedAt (Aws::Utils::DateTime &&value)
 
IndexConfigurationSummaryWithUpdatedAt (const Aws::Utils::DateTime &value)
 
IndexConfigurationSummaryWithUpdatedAt (Aws::Utils::DateTime &&value)
 
const IndexStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const IndexStatus &value)
 
void SetStatus (IndexStatus &&value)
 
IndexConfigurationSummaryWithStatus (const IndexStatus &value)
 
IndexConfigurationSummaryWithStatus (IndexStatus &&value)
 

Detailed Description

A summary of information about an index.

See Also:

AWS API Reference

Definition at line 34 of file IndexConfigurationSummary.h.

Constructor & Destructor Documentation

◆ IndexConfigurationSummary() [1/2]

Aws::kendra::Model::IndexConfigurationSummary::IndexConfigurationSummary ( )

◆ IndexConfigurationSummary() [2/2]

Aws::kendra::Model::IndexConfigurationSummary::IndexConfigurationSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreatedAtHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::CreatedAtHasBeenSet ( ) const
inline

The Unix timestamp when the index was created.

Definition at line 186 of file IndexConfigurationSummary.h.

◆ EditionHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::EditionHasBeenSet ( ) const
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 151 of file IndexConfigurationSummary.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::IndexConfigurationSummary::GetCreatedAt ( ) const
inline

The Unix timestamp when the index was created.

Definition at line 181 of file IndexConfigurationSummary.h.

◆ GetEdition()

const IndexEdition& Aws::kendra::Model::IndexConfigurationSummary::GetEdition ( ) const
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 145 of file IndexConfigurationSummary.h.

◆ GetId()

const Aws::String& Aws::kendra::Model::IndexConfigurationSummary::GetId ( ) const
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 89 of file IndexConfigurationSummary.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::IndexConfigurationSummary::GetName ( ) const
inline

The name of the index.

Definition at line 46 of file IndexConfigurationSummary.h.

◆ GetStatus()

const IndexStatus& Aws::kendra::Model::IndexConfigurationSummary::GetStatus ( ) const
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 250 of file IndexConfigurationSummary.h.

◆ GetUpdatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::IndexConfigurationSummary::GetUpdatedAt ( ) const
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 213 of file IndexConfigurationSummary.h.

◆ IdHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::IdHasBeenSet ( ) const
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 96 of file IndexConfigurationSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::IndexConfigurationSummary::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::NameHasBeenSet ( ) const
inline

The name of the index.

Definition at line 51 of file IndexConfigurationSummary.h.

◆ operator=()

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCreatedAt() [1/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp when the index was created.

Definition at line 196 of file IndexConfigurationSummary.h.

◆ SetCreatedAt() [2/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp when the index was created.

Definition at line 191 of file IndexConfigurationSummary.h.

◆ SetEdition() [1/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetEdition ( const IndexEdition value)
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 157 of file IndexConfigurationSummary.h.

◆ SetEdition() [2/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetEdition ( IndexEdition &&  value)
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 163 of file IndexConfigurationSummary.h.

◆ SetId() [1/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetId ( Aws::String &&  value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 110 of file IndexConfigurationSummary.h.

◆ SetId() [2/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetId ( const Aws::String value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 103 of file IndexConfigurationSummary.h.

◆ SetId() [3/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetId ( const char *  value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 117 of file IndexConfigurationSummary.h.

◆ SetName() [1/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetName ( Aws::String &&  value)
inline

The name of the index.

Definition at line 61 of file IndexConfigurationSummary.h.

◆ SetName() [2/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetName ( const Aws::String value)
inline

The name of the index.

Definition at line 56 of file IndexConfigurationSummary.h.

◆ SetName() [3/3]

void Aws::kendra::Model::IndexConfigurationSummary::SetName ( const char *  value)
inline

The name of the index.

Definition at line 66 of file IndexConfigurationSummary.h.

◆ SetStatus() [1/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetStatus ( const IndexStatus value)
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 262 of file IndexConfigurationSummary.h.

◆ SetStatus() [2/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetStatus ( IndexStatus &&  value)
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 268 of file IndexConfigurationSummary.h.

◆ SetUpdatedAt() [1/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 231 of file IndexConfigurationSummary.h.

◆ SetUpdatedAt() [2/2]

void Aws::kendra::Model::IndexConfigurationSummary::SetUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 225 of file IndexConfigurationSummary.h.

◆ StatusHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::StatusHasBeenSet ( ) const
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 256 of file IndexConfigurationSummary.h.

◆ UpdatedAtHasBeenSet()

bool Aws::kendra::Model::IndexConfigurationSummary::UpdatedAtHasBeenSet ( ) const
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 219 of file IndexConfigurationSummary.h.

◆ WithCreatedAt() [1/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp when the index was created.

Definition at line 206 of file IndexConfigurationSummary.h.

◆ WithCreatedAt() [2/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp when the index was created.

Definition at line 201 of file IndexConfigurationSummary.h.

◆ WithEdition() [1/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithEdition ( const IndexEdition value)
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 169 of file IndexConfigurationSummary.h.

◆ WithEdition() [2/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithEdition ( IndexEdition &&  value)
inline

Indicates whether the index is a enterprise edition index or a developer edition index.

Definition at line 175 of file IndexConfigurationSummary.h.

◆ WithId() [1/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithId ( Aws::String &&  value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 131 of file IndexConfigurationSummary.h.

◆ WithId() [2/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithId ( const Aws::String value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 124 of file IndexConfigurationSummary.h.

◆ WithId() [3/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithId ( const char *  value)
inline

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Definition at line 138 of file IndexConfigurationSummary.h.

◆ WithName() [1/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithName ( Aws::String &&  value)
inline

The name of the index.

Definition at line 76 of file IndexConfigurationSummary.h.

◆ WithName() [2/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithName ( const Aws::String value)
inline

The name of the index.

Definition at line 71 of file IndexConfigurationSummary.h.

◆ WithName() [3/3]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithName ( const char *  value)
inline

The name of the index.

Definition at line 81 of file IndexConfigurationSummary.h.

◆ WithStatus() [1/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithStatus ( const IndexStatus value)
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 274 of file IndexConfigurationSummary.h.

◆ WithStatus() [2/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithStatus ( IndexStatus &&  value)
inline

The current status of the index. When the status is ACTIVE, the index is ready to search.

Definition at line 280 of file IndexConfigurationSummary.h.

◆ WithUpdatedAt() [1/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 243 of file IndexConfigurationSummary.h.

◆ WithUpdatedAt() [2/2]

IndexConfigurationSummary& Aws::kendra::Model::IndexConfigurationSummary::WithUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Definition at line 237 of file IndexConfigurationSummary.h.


The documentation for this class was generated from the following file: