1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct TranslateTextInput {
/// <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.</p>
pub text: ::std::option::Option<::std::string::String>,
/// <p>The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.</p>
/// <p>Use the <code>ListTerminologies</code> operation to get the available terminology lists.</p>
/// <p>For more information about custom terminology lists, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html">Custom terminology</a>.</p>
pub terminology_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon Comprehend</a> to determine the source language.</p><note>
/// <p>If you specify <code>auto</code>, you must send the <code>TranslateText</code> request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.</p>
/// </note>
pub source_language_code: ::std::option::Option<::std::string::String>,
/// <p>The language code requested for the language of the target text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
pub target_language_code: ::std::option::Option<::std::string::String>,
/// <p>Settings to configure your translation output. You can configure the following options:</p>
/// <ul>
/// <li>
/// <p>Brevity: reduces the length of the translated output for most translations.</p></li>
/// <li>
/// <p>Formality: sets the formality level of the output text.</p></li>
/// <li>
/// <p>Profanity: masks profane words and phrases in your translation output.</p></li>
/// </ul>
pub settings: ::std::option::Option<crate::types::TranslationSettings>,
}
impl TranslateTextInput {
/// <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.</p>
pub fn text(&self) -> ::std::option::Option<&str> {
self.text.as_deref()
}
/// <p>The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.</p>
/// <p>Use the <code>ListTerminologies</code> operation to get the available terminology lists.</p>
/// <p>For more information about custom terminology lists, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html">Custom terminology</a>.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.terminology_names.is_none()`.
pub fn terminology_names(&self) -> &[::std::string::String] {
self.terminology_names.as_deref().unwrap_or_default()
}
/// <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon Comprehend</a> to determine the source language.</p><note>
/// <p>If you specify <code>auto</code>, you must send the <code>TranslateText</code> request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.</p>
/// </note>
pub fn source_language_code(&self) -> ::std::option::Option<&str> {
self.source_language_code.as_deref()
}
/// <p>The language code requested for the language of the target text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
pub fn target_language_code(&self) -> ::std::option::Option<&str> {
self.target_language_code.as_deref()
}
/// <p>Settings to configure your translation output. You can configure the following options:</p>
/// <ul>
/// <li>
/// <p>Brevity: reduces the length of the translated output for most translations.</p></li>
/// <li>
/// <p>Formality: sets the formality level of the output text.</p></li>
/// <li>
/// <p>Profanity: masks profane words and phrases in your translation output.</p></li>
/// </ul>
pub fn settings(&self) -> ::std::option::Option<&crate::types::TranslationSettings> {
self.settings.as_ref()
}
}
impl TranslateTextInput {
/// Creates a new builder-style object to manufacture [`TranslateTextInput`](crate::operation::translate_text::TranslateTextInput).
pub fn builder() -> crate::operation::translate_text::builders::TranslateTextInputBuilder {
crate::operation::translate_text::builders::TranslateTextInputBuilder::default()
}
}
/// A builder for [`TranslateTextInput`](crate::operation::translate_text::TranslateTextInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct TranslateTextInputBuilder {
pub(crate) text: ::std::option::Option<::std::string::String>,
pub(crate) terminology_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) source_language_code: ::std::option::Option<::std::string::String>,
pub(crate) target_language_code: ::std::option::Option<::std::string::String>,
pub(crate) settings: ::std::option::Option<crate::types::TranslationSettings>,
}
impl TranslateTextInputBuilder {
/// <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.</p>
/// This field is required.
pub fn text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.text = ::std::option::Option::Some(input.into());
self
}
/// <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.</p>
pub fn set_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.text = input;
self
}
/// <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.</p>
pub fn get_text(&self) -> &::std::option::Option<::std::string::String> {
&self.text
}
/// Appends an item to `terminology_names`.
///
/// To override the contents of this collection use [`set_terminology_names`](Self::set_terminology_names).
///
/// <p>The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.</p>
/// <p>Use the <code>ListTerminologies</code> operation to get the available terminology lists.</p>
/// <p>For more information about custom terminology lists, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html">Custom terminology</a>.</p>
pub fn terminology_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.terminology_names.unwrap_or_default();
v.push(input.into());
self.terminology_names = ::std::option::Option::Some(v);
self
}
/// <p>The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.</p>
/// <p>Use the <code>ListTerminologies</code> operation to get the available terminology lists.</p>
/// <p>For more information about custom terminology lists, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html">Custom terminology</a>.</p>
pub fn set_terminology_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.terminology_names = input;
self
}
/// <p>The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.</p>
/// <p>Use the <code>ListTerminologies</code> operation to get the available terminology lists.</p>
/// <p>For more information about custom terminology lists, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html">Custom terminology</a>.</p>
pub fn get_terminology_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.terminology_names
}
/// <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon Comprehend</a> to determine the source language.</p><note>
/// <p>If you specify <code>auto</code>, you must send the <code>TranslateText</code> request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.</p>
/// </note>
/// This field is required.
pub fn source_language_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.source_language_code = ::std::option::Option::Some(input.into());
self
}
/// <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon Comprehend</a> to determine the source language.</p><note>
/// <p>If you specify <code>auto</code>, you must send the <code>TranslateText</code> request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.</p>
/// </note>
pub fn set_source_language_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.source_language_code = input;
self
}
/// <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon Comprehend</a> to determine the source language.</p><note>
/// <p>If you specify <code>auto</code>, you must send the <code>TranslateText</code> request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.</p>
/// </note>
pub fn get_source_language_code(&self) -> &::std::option::Option<::std::string::String> {
&self.source_language_code
}
/// <p>The language code requested for the language of the target text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
/// This field is required.
pub fn target_language_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.target_language_code = ::std::option::Option::Some(input.into());
self
}
/// <p>The language code requested for the language of the target text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
pub fn set_target_language_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.target_language_code = input;
self
}
/// <p>The language code requested for the language of the target text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
pub fn get_target_language_code(&self) -> &::std::option::Option<::std::string::String> {
&self.target_language_code
}
/// <p>Settings to configure your translation output. You can configure the following options:</p>
/// <ul>
/// <li>
/// <p>Brevity: reduces the length of the translated output for most translations.</p></li>
/// <li>
/// <p>Formality: sets the formality level of the output text.</p></li>
/// <li>
/// <p>Profanity: masks profane words and phrases in your translation output.</p></li>
/// </ul>
pub fn settings(mut self, input: crate::types::TranslationSettings) -> Self {
self.settings = ::std::option::Option::Some(input);
self
}
/// <p>Settings to configure your translation output. You can configure the following options:</p>
/// <ul>
/// <li>
/// <p>Brevity: reduces the length of the translated output for most translations.</p></li>
/// <li>
/// <p>Formality: sets the formality level of the output text.</p></li>
/// <li>
/// <p>Profanity: masks profane words and phrases in your translation output.</p></li>
/// </ul>
pub fn set_settings(mut self, input: ::std::option::Option<crate::types::TranslationSettings>) -> Self {
self.settings = input;
self
}
/// <p>Settings to configure your translation output. You can configure the following options:</p>
/// <ul>
/// <li>
/// <p>Brevity: reduces the length of the translated output for most translations.</p></li>
/// <li>
/// <p>Formality: sets the formality level of the output text.</p></li>
/// <li>
/// <p>Profanity: masks profane words and phrases in your translation output.</p></li>
/// </ul>
pub fn get_settings(&self) -> &::std::option::Option<crate::types::TranslationSettings> {
&self.settings
}
/// Consumes the builder and constructs a [`TranslateTextInput`](crate::operation::translate_text::TranslateTextInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::translate_text::TranslateTextInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::translate_text::TranslateTextInput {
text: self.text,
terminology_names: self.terminology_names,
source_language_code: self.source_language_code,
target_language_code: self.target_language_code,
settings: self.settings,
})
}
}