/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/connect/Connect_EXPORTS.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/connect/model/VocabularyLanguageCode.h> #include <aws/connect/model/VocabularyState.h> #include <aws/core/utils/DateTime.h> #include <aws/core/utils/memory/stl/AWSMap.h> #include <utility> namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Connect { namespace Model { /** * <p>Contains information about a custom vocabulary.</p><p><h3>See Also:</h3> <a * href="http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Vocabulary">AWS * API Reference</a></p> */ class Vocabulary { public: AWS_CONNECT_API Vocabulary(); AWS_CONNECT_API Vocabulary(Aws::Utils::Json::JsonView jsonValue); AWS_CONNECT_API Vocabulary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_CONNECT_API Aws::Utils::Json::JsonValue Jsonize() const; /** * <p>A unique name of the custom vocabulary.</p> */ inline const Aws::String& GetName() const{ return m_name; } /** * <p>A unique name of the custom vocabulary.</p> */ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** * <p>A unique name of the custom vocabulary.</p> */ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** * <p>A unique name of the custom vocabulary.</p> */ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** * <p>A unique name of the custom vocabulary.</p> */ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** * <p>A unique name of the custom vocabulary.</p> */ inline Vocabulary& WithName(const Aws::String& value) { SetName(value); return *this;} /** * <p>A unique name of the custom vocabulary.</p> */ inline Vocabulary& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** * <p>A unique name of the custom vocabulary.</p> */ inline Vocabulary& WithName(const char* value) { SetName(value); return *this;} /** * <p>The identifier of the custom vocabulary.</p> */ inline const Aws::String& GetId() const{ return m_id; } /** * <p>The identifier of the custom vocabulary.</p> */ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** * <p>The identifier of the custom vocabulary.</p> */ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** * <p>The identifier of the custom vocabulary.</p> */ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** * <p>The identifier of the custom vocabulary.</p> */ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** * <p>The identifier of the custom vocabulary.</p> */ inline Vocabulary& WithId(const Aws::String& value) { SetId(value); return *this;} /** * <p>The identifier of the custom vocabulary.</p> */ inline Vocabulary& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** * <p>The identifier of the custom vocabulary.</p> */ inline Vocabulary& WithId(const char* value) { SetId(value); return *this;} /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline const Aws::String& GetArn() const{ return m_arn; } /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline Vocabulary& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline Vocabulary& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p> */ inline Vocabulary& WithArn(const char* value) { SetArn(value); return *this;} /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline const VocabularyLanguageCode& GetLanguageCode() const{ return m_languageCode; } /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline void SetLanguageCode(const VocabularyLanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline void SetLanguageCode(VocabularyLanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline Vocabulary& WithLanguageCode(const VocabularyLanguageCode& value) { SetLanguageCode(value); return *this;} /** * <p>The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What * is Amazon Transcribe?</a> </p> */ inline Vocabulary& WithLanguageCode(VocabularyLanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** * <p>The current state of the custom vocabulary.</p> */ inline const VocabularyState& GetState() const{ return m_state; } /** * <p>The current state of the custom vocabulary.</p> */ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** * <p>The current state of the custom vocabulary.</p> */ inline void SetState(const VocabularyState& value) { m_stateHasBeenSet = true; m_state = value; } /** * <p>The current state of the custom vocabulary.</p> */ inline void SetState(VocabularyState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** * <p>The current state of the custom vocabulary.</p> */ inline Vocabulary& WithState(const VocabularyState& value) { SetState(value); return *this;} /** * <p>The current state of the custom vocabulary.</p> */ inline Vocabulary& WithState(VocabularyState&& value) { SetState(std::move(value)); return *this;} /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::move(value); } /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline Vocabulary& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** * <p>The timestamp when the custom vocabulary was last modified.</p> */ inline Vocabulary& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** * <p>The reason why the custom vocabulary was not created.</p> */ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** * <p>The reason why the custom vocabulary was not created.</p> */ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** * <p>The reason why the custom vocabulary was not created.</p> */ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** * <p>The reason why the custom vocabulary was not created.</p> */ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** * <p>The reason why the custom vocabulary was not created.</p> */ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** * <p>The reason why the custom vocabulary was not created.</p> */ inline Vocabulary& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** * <p>The reason why the custom vocabulary was not created.</p> */ inline Vocabulary& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** * <p>The reason why the custom vocabulary was not created.</p> */ inline Vocabulary& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline const Aws::String& GetContent() const{ return m_content; } /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline bool ContentHasBeenSet() const { return m_contentHasBeenSet; } /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline void SetContent(const Aws::String& value) { m_contentHasBeenSet = true; m_content = value; } /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline void SetContent(Aws::String&& value) { m_contentHasBeenSet = true; m_content = std::move(value); } /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline void SetContent(const char* value) { m_contentHasBeenSet = true; m_content.assign(value); } /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline Vocabulary& WithContent(const Aws::String& value) { SetContent(value); return *this;} /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline Vocabulary& WithContent(Aws::String&& value) { SetContent(std::move(value)); return *this;} /** * <p>The content of the custom vocabulary in plain-text format with a table of * values. Each row in the table represents a word or a phrase, described with * <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and * <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more * information, see <a * href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create * a custom vocabulary using a table</a>.</p> */ inline Vocabulary& WithContent(const char* value) { SetContent(value); return *this;} /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;} /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;} /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** * <p>The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.</p> */ inline Vocabulary& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_arn; bool m_arnHasBeenSet = false; VocabularyLanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; VocabularyState m_state; bool m_stateHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; Aws::String m_content; bool m_contentHasBeenSet = false; Aws::Map<Aws::String, Aws::String> m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace Connect } // namespace Aws