/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/transcribe/TranscribeServiceRequest.h>
#include <aws/transcribe/TranscribeService_EXPORTS.h>

#include <utility>

namespace Aws {
namespace TranscribeService {
namespace Model {

/**
 */
class UpdateVocabularyFilterRequest : public TranscribeServiceRequest {
 public:
  AWS_TRANSCRIBESERVICE_API UpdateVocabularyFilterRequest() = default;

  // Service request name is the Operation name which will send this request out,
  // each operation should has unique request name, so that we can get operation's name from this request.
  // Note: this is not true for response, multiple operations may have the same response name,
  // so we can not get operation's name from response.
  inline virtual const char* GetServiceRequestName() const override { return "UpdateVocabularyFilter"; }

  AWS_TRANSCRIBESERVICE_API Aws::String SerializePayload() const override;

  AWS_TRANSCRIBESERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;

  ///@{
  /**
   * <p>The name of the custom vocabulary filter you want to update. Custom
   * vocabulary filter names are case sensitive.</p>
   */
  inline const Aws::String& GetVocabularyFilterName() const { return m_vocabularyFilterName; }
  inline bool VocabularyFilterNameHasBeenSet() const { return m_vocabularyFilterNameHasBeenSet; }
  template <typename VocabularyFilterNameT = Aws::String>
  void SetVocabularyFilterName(VocabularyFilterNameT&& value) {
    m_vocabularyFilterNameHasBeenSet = true;
    m_vocabularyFilterName = std::forward<VocabularyFilterNameT>(value);
  }
  template <typename VocabularyFilterNameT = Aws::String>
  UpdateVocabularyFilterRequest& WithVocabularyFilterName(VocabularyFilterNameT&& value) {
    SetVocabularyFilterName(std::forward<VocabularyFilterNameT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>Use this parameter if you want to update your custom vocabulary filter by
   * including all desired terms, as comma-separated values, within your request. The
   * other option for updating your vocabulary filter is to save your entries in a
   * text file and upload them to an Amazon S3 bucket, then specify the location of
   * your file using the <code>VocabularyFilterFileUri</code> parameter.</p> <p>Note
   * that if you include <code>Words</code> in your request, you cannot use
   * <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
   * <p>Each language has a character set that contains all allowed characters for
   * that specific language. If you use unsupported characters, your custom
   * vocabulary filter request fails. Refer to <a
   * href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character
   * Sets for Custom Vocabularies</a> to get the character set for your language.</p>
   */
  inline const Aws::Vector<Aws::String>& GetWords() const { return m_words; }
  inline bool WordsHasBeenSet() const { return m_wordsHasBeenSet; }
  template <typename WordsT = Aws::Vector<Aws::String>>
  void SetWords(WordsT&& value) {
    m_wordsHasBeenSet = true;
    m_words = std::forward<WordsT>(value);
  }
  template <typename WordsT = Aws::Vector<Aws::String>>
  UpdateVocabularyFilterRequest& WithWords(WordsT&& value) {
    SetWords(std::forward<WordsT>(value));
    return *this;
  }
  template <typename WordsT = Aws::String>
  UpdateVocabularyFilterRequest& AddWords(WordsT&& value) {
    m_wordsHasBeenSet = true;
    m_words.emplace_back(std::forward<WordsT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>The Amazon S3 location of the text file that contains your custom vocabulary
   * filter terms. The URI must be located in the same Amazon Web Services Region as
   * the resource you're calling.</p> <p>Here's an example URI path:
   * <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</code> </p> <p>Note that
   * if you include <code>VocabularyFilterFileUri</code> in your request, you cannot
   * use <code>Words</code>; you must choose one or the other.</p>
   */
  inline const Aws::String& GetVocabularyFilterFileUri() const { return m_vocabularyFilterFileUri; }
  inline bool VocabularyFilterFileUriHasBeenSet() const { return m_vocabularyFilterFileUriHasBeenSet; }
  template <typename VocabularyFilterFileUriT = Aws::String>
  void SetVocabularyFilterFileUri(VocabularyFilterFileUriT&& value) {
    m_vocabularyFilterFileUriHasBeenSet = true;
    m_vocabularyFilterFileUri = std::forward<VocabularyFilterFileUriT>(value);
  }
  template <typename VocabularyFilterFileUriT = Aws::String>
  UpdateVocabularyFilterRequest& WithVocabularyFilterFileUri(VocabularyFilterFileUriT&& value) {
    SetVocabularyFilterFileUri(std::forward<VocabularyFilterFileUriT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to access
   * the Amazon S3 bucket that contains your input files (in this case, your custom
   * vocabulary filter). If the role that you specify doesn’t have the appropriate
   * permissions to access the specified Amazon S3 location, your request fails.</p>
   * <p>IAM role ARNs have the format
   * <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
   * <code>arn:aws:iam::111122223333:role/Admin</code>.</p> <p>For more information,
   * see <a
   * href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
   * ARNs</a>.</p>
   */
  inline const Aws::String& GetDataAccessRoleArn() const { return m_dataAccessRoleArn; }
  inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; }
  template <typename DataAccessRoleArnT = Aws::String>
  void SetDataAccessRoleArn(DataAccessRoleArnT&& value) {
    m_dataAccessRoleArnHasBeenSet = true;
    m_dataAccessRoleArn = std::forward<DataAccessRoleArnT>(value);
  }
  template <typename DataAccessRoleArnT = Aws::String>
  UpdateVocabularyFilterRequest& WithDataAccessRoleArn(DataAccessRoleArnT&& value) {
    SetDataAccessRoleArn(std::forward<DataAccessRoleArnT>(value));
    return *this;
  }
  ///@}
 private:
  Aws::String m_vocabularyFilterName;

  Aws::Vector<Aws::String> m_words;

  Aws::String m_vocabularyFilterFileUri;

  Aws::String m_dataAccessRoleArn;
  bool m_vocabularyFilterNameHasBeenSet = false;
  bool m_wordsHasBeenSet = false;
  bool m_vocabularyFilterFileUriHasBeenSet = false;
  bool m_dataAccessRoleArnHasBeenSet = false;
};

}  // namespace Model
}  // namespace TranscribeService
}  // namespace Aws
