/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Translate { namespace Model { /** */ class StartTextTranslationJobRequest : public TranslateRequest { public: AWS_TRANSLATE_API StartTextTranslationJobRequest(); // 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 "StartTextTranslationJob"; } AWS_TRANSLATE_API Aws::String SerializePayload() const override; AWS_TRANSLATE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the batch translation job to be performed.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

The name of the batch translation job to be performed.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

The name of the batch translation job to be performed.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

The name of the batch translation job to be performed.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

The name of the batch translation job to be performed.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

The name of the batch translation job to be performed.

*/ inline StartTextTranslationJobRequest& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

The name of the batch translation job to be performed.

*/ inline StartTextTranslationJobRequest& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

The name of the batch translation job to be performed.

*/ inline StartTextTranslationJobRequest& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline const InputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; } /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; } /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline void SetInputDataConfig(const InputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; } /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline void SetInputDataConfig(InputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); } /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline StartTextTranslationJobRequest& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

Specifies the format and location of the input documents for the translation * job.

*/ inline StartTextTranslationJobRequest& WithInputDataConfig(InputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;} /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline const OutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; } /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; } /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline void SetOutputDataConfig(const OutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; } /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline void SetOutputDataConfig(OutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); } /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline StartTextTranslationJobRequest& WithOutputDataConfig(const OutputDataConfig& value) { SetOutputDataConfig(value); return *this;} /** *

Specifies the S3 folder to which your job output will be saved.

*/ inline StartTextTranslationJobRequest& WithOutputDataConfig(OutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) * role that grants Amazon Translate read access to your input data. For more * information, see Identity * and access management .

*/ inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; } /** *

*/ inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; } /** *

*/ inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; } /** *

*/ inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); } /** *

*/ inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); } /** *

*/ inline StartTextTranslationJobRequest& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;} /** *

*/ inline StartTextTranslationJobRequest& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;} /** *

*/ inline StartTextTranslationJobRequest& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *

The language code of the input language. Specify the language if all input * documents share the same language. If you don't know the language of the source * files, or your input documents contains different source languages, select * auto. Amazon Translate auto detects the source language for each * input document. For a list of supported language codes, see Supported * languages.

*/ inline const Aws::String& GetSourceLanguageCode() const{ return m_sourceLanguageCode; } /** *

*/ inline bool SourceLanguageCodeHasBeenSet() const { return m_sourceLanguageCodeHasBeenSet; } /** *

*/ inline void SetSourceLanguageCode(const Aws::String& value) { m_sourceLanguageCodeHasBeenSet = true; m_sourceLanguageCode = value; } /** *

*/ inline void SetSourceLanguageCode(Aws::String&& value) { m_sourceLanguageCodeHasBeenSet = true; m_sourceLanguageCode = std::move(value); } /** *

*/ inline void SetSourceLanguageCode(const char* value) { m_sourceLanguageCodeHasBeenSet = true; m_sourceLanguageCode.assign(value); } /** *

*/ inline StartTextTranslationJobRequest& WithSourceLanguageCode(const Aws::String& value) { SetSourceLanguageCode(value); return *this;} /** *

*/ inline StartTextTranslationJobRequest& WithSourceLanguageCode(Aws::String&& value) { SetSourceLanguageCode(std::move(value)); return *this;} /** *

*/ inline StartTextTranslationJobRequest& WithSourceLanguageCode(const char* value) { SetSourceLanguageCode(value); return *this;} /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline const Aws::Vector& GetTargetLanguageCodes() const{ return m_targetLanguageCodes; } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline bool TargetLanguageCodesHasBeenSet() const { return m_targetLanguageCodesHasBeenSet; } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline void SetTargetLanguageCodes(const Aws::Vector& value) { m_targetLanguageCodesHasBeenSet = true; m_targetLanguageCodes = value; } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline void SetTargetLanguageCodes(Aws::Vector&& value) { m_targetLanguageCodesHasBeenSet = true; m_targetLanguageCodes = std::move(value); } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline StartTextTranslationJobRequest& WithTargetLanguageCodes(const Aws::Vector& value) { SetTargetLanguageCodes(value); return *this;} /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline StartTextTranslationJobRequest& WithTargetLanguageCodes(Aws::Vector&& value) { SetTargetLanguageCodes(std::move(value)); return *this;} /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline StartTextTranslationJobRequest& AddTargetLanguageCodes(const Aws::String& value) { m_targetLanguageCodesHasBeenSet = true; m_targetLanguageCodes.push_back(value); return *this; } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline StartTextTranslationJobRequest& AddTargetLanguageCodes(Aws::String&& value) { m_targetLanguageCodesHasBeenSet = true; m_targetLanguageCodes.push_back(std::move(value)); return *this; } /** *

The target languages of the translation job. Enter up to 10 language codes. * Each input file is translated into each target language.

Each language * code is 2 or 5 characters long. For a list of language codes, see Supported * languages.

*/ inline StartTextTranslationJobRequest& AddTargetLanguageCodes(const char* value) { m_targetLanguageCodesHasBeenSet = true; m_targetLanguageCodes.push_back(value); return *this; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline const Aws::Vector& GetTerminologyNames() const{ return m_terminologyNames; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline bool TerminologyNamesHasBeenSet() const { return m_terminologyNamesHasBeenSet; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline void SetTerminologyNames(const Aws::Vector& value) { m_terminologyNamesHasBeenSet = true; m_terminologyNames = value; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline void SetTerminologyNames(Aws::Vector&& value) { m_terminologyNamesHasBeenSet = true; m_terminologyNames = std::move(value); } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline StartTextTranslationJobRequest& WithTerminologyNames(const Aws::Vector& value) { SetTerminologyNames(value); return *this;} /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline StartTextTranslationJobRequest& WithTerminologyNames(Aws::Vector&& value) { SetTerminologyNames(std::move(value)); return *this;} /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline StartTextTranslationJobRequest& AddTerminologyNames(const Aws::String& value) { m_terminologyNamesHasBeenSet = true; m_terminologyNames.push_back(value); return *this; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline StartTextTranslationJobRequest& AddTerminologyNames(Aws::String&& value) { m_terminologyNamesHasBeenSet = true; m_terminologyNames.push_back(std::move(value)); return *this; } /** *

The name of a custom terminology resource to add to the translation job. This * resource lists examples source terms and the desired translation for each * term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the * designated terminology for each requested target language that has an entry for * the source term in the terminology file.

For a list of available custom * terminology resources, use the ListTerminologies operation.

For * more information, see Custom * terminology.

*/ inline StartTextTranslationJobRequest& AddTerminologyNames(const char* value) { m_terminologyNamesHasBeenSet = true; m_terminologyNames.push_back(value); return *this; } /** *

The name of a parallel data resource to add to the translation job. This * resource consists of examples that show how you want segments of text to be * translated. If you specify multiple target languages for the job, the parallel * data file must include translations for all the target languages.

When * you add parallel data to a translation job, you create an Active Custom * Translation job.

This parameter accepts only one parallel data * resource.

Active Custom Translation jobs are priced at a higher * rate than other jobs that don't use parallel data. For more information, see Amazon Translate * pricing.