This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-kendra/include/aws/kendra/model/IndexConfigurationSummary.h

306 lines
10 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/kendra/Kendra_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/kendra/model/IndexEdition.h>
#include <aws/core/utils/DateTime.h>
#include <aws/kendra/model/IndexStatus.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace kendra
{
namespace Model
{
/**
* <p>A summary of information about an index.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/IndexConfigurationSummary">AWS
* API Reference</a></p>
*/
class AWS_KENDRA_API IndexConfigurationSummary
{
public:
IndexConfigurationSummary();
IndexConfigurationSummary(Aws::Utils::Json::JsonView jsonValue);
IndexConfigurationSummary& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name of the index.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the index.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the index.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the index.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the index.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the index.</p>
*/
inline IndexConfigurationSummary& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the index.</p>
*/
inline IndexConfigurationSummary& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the index.</p>
*/
inline IndexConfigurationSummary& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline const Aws::String& GetId() const{ return m_id; }
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; }
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); }
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); }
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline IndexConfigurationSummary& WithId(const Aws::String& value) { SetId(value); return *this;}
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline IndexConfigurationSummary& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;}
/**
* <p>A unique identifier for the index. Use this to identify the index when you
* are using operations such as <code>Query</code>, <code>DescribeIndex</code>,
* <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>
*/
inline IndexConfigurationSummary& WithId(const char* value) { SetId(value); return *this;}
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline const IndexEdition& GetEdition() const{ return m_edition; }
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline bool EditionHasBeenSet() const { return m_editionHasBeenSet; }
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline void SetEdition(const IndexEdition& value) { m_editionHasBeenSet = true; m_edition = value; }
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline void SetEdition(IndexEdition&& value) { m_editionHasBeenSet = true; m_edition = std::move(value); }
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline IndexConfigurationSummary& WithEdition(const IndexEdition& value) { SetEdition(value); return *this;}
/**
* <p>Indicates whether the index is a enterprise edition index or a developer
* edition index. </p>
*/
inline IndexConfigurationSummary& WithEdition(IndexEdition&& value) { SetEdition(std::move(value)); return *this;}
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; }
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline bool CreatedAtHasBeenSet() const { return m_createdAtHasBeenSet; }
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAtHasBeenSet = true; m_createdAt = value; }
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAtHasBeenSet = true; m_createdAt = std::move(value); }
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline IndexConfigurationSummary& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;}
/**
* <p>The Unix timestamp when the index was created.</p>
*/
inline IndexConfigurationSummary& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;}
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline const Aws::Utils::DateTime& GetUpdatedAt() const{ return m_updatedAt; }
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline bool UpdatedAtHasBeenSet() const { return m_updatedAtHasBeenSet; }
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline void SetUpdatedAt(const Aws::Utils::DateTime& value) { m_updatedAtHasBeenSet = true; m_updatedAt = value; }
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline void SetUpdatedAt(Aws::Utils::DateTime&& value) { m_updatedAtHasBeenSet = true; m_updatedAt = std::move(value); }
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline IndexConfigurationSummary& WithUpdatedAt(const Aws::Utils::DateTime& value) { SetUpdatedAt(value); return *this;}
/**
* <p>The Unix timestamp when the index was last updated by the
* <code>UpdateIndex</code> operation.</p>
*/
inline IndexConfigurationSummary& WithUpdatedAt(Aws::Utils::DateTime&& value) { SetUpdatedAt(std::move(value)); return *this;}
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline const IndexStatus& GetStatus() const{ return m_status; }
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline void SetStatus(const IndexStatus& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline void SetStatus(IndexStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline IndexConfigurationSummary& WithStatus(const IndexStatus& value) { SetStatus(value); return *this;}
/**
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the
* index is ready to search.</p>
*/
inline IndexConfigurationSummary& WithStatus(IndexStatus&& value) { SetStatus(std::move(value)); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
Aws::String m_id;
bool m_idHasBeenSet;
IndexEdition m_edition;
bool m_editionHasBeenSet;
Aws::Utils::DateTime m_createdAt;
bool m_createdAtHasBeenSet;
Aws::Utils::DateTime m_updatedAt;
bool m_updatedAtHasBeenSet;
IndexStatus m_status;
bool m_statusHasBeenSet;
};
} // namespace Model
} // namespace kendra
} // namespace Aws