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
// 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 GetVocabularyOutput {
/// <p>The name of the custom vocabulary you requested information about.</p>
pub vocabulary_name: ::std::option::Option<::std::string::String>,
/// <p>The language code you selected for your custom vocabulary.</p>
pub language_code: ::std::option::Option<crate::types::LanguageCode>,
/// <p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>
pub vocabulary_state: ::std::option::Option<crate::types::VocabularyState>,
/// <p>The date and time the specified custom vocabulary was last modified.</p>
/// <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
pub failure_reason: ::std::option::Option<::std::string::String>,
/// <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>
pub download_uri: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetVocabularyOutput {
/// <p>The name of the custom vocabulary you requested information about.</p>
pub fn vocabulary_name(&self) -> ::std::option::Option<&str> {
self.vocabulary_name.as_deref()
}
/// <p>The language code you selected for your custom vocabulary.</p>
pub fn language_code(&self) -> ::std::option::Option<&crate::types::LanguageCode> {
self.language_code.as_ref()
}
/// <p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>
pub fn vocabulary_state(&self) -> ::std::option::Option<&crate::types::VocabularyState> {
self.vocabulary_state.as_ref()
}
/// <p>The date and time the specified custom vocabulary was last modified.</p>
/// <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified_time.as_ref()
}
/// <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
pub fn failure_reason(&self) -> ::std::option::Option<&str> {
self.failure_reason.as_deref()
}
/// <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>
pub fn download_uri(&self) -> ::std::option::Option<&str> {
self.download_uri.as_deref()
}
}
impl ::aws_types::request_id::RequestId for GetVocabularyOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetVocabularyOutput {
/// Creates a new builder-style object to manufacture [`GetVocabularyOutput`](crate::operation::get_vocabulary::GetVocabularyOutput).
pub fn builder() -> crate::operation::get_vocabulary::builders::GetVocabularyOutputBuilder {
crate::operation::get_vocabulary::builders::GetVocabularyOutputBuilder::default()
}
}
/// A builder for [`GetVocabularyOutput`](crate::operation::get_vocabulary::GetVocabularyOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetVocabularyOutputBuilder {
pub(crate) vocabulary_name: ::std::option::Option<::std::string::String>,
pub(crate) language_code: ::std::option::Option<crate::types::LanguageCode>,
pub(crate) vocabulary_state: ::std::option::Option<crate::types::VocabularyState>,
pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
pub(crate) download_uri: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetVocabularyOutputBuilder {
/// <p>The name of the custom vocabulary you requested information about.</p>
pub fn vocabulary_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.vocabulary_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the custom vocabulary you requested information about.</p>
pub fn set_vocabulary_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.vocabulary_name = input;
self
}
/// <p>The name of the custom vocabulary you requested information about.</p>
pub fn get_vocabulary_name(&self) -> &::std::option::Option<::std::string::String> {
&self.vocabulary_name
}
/// <p>The language code you selected for your custom vocabulary.</p>
pub fn language_code(mut self, input: crate::types::LanguageCode) -> Self {
self.language_code = ::std::option::Option::Some(input);
self
}
/// <p>The language code you selected for your custom vocabulary.</p>
pub fn set_language_code(mut self, input: ::std::option::Option<crate::types::LanguageCode>) -> Self {
self.language_code = input;
self
}
/// <p>The language code you selected for your custom vocabulary.</p>
pub fn get_language_code(&self) -> &::std::option::Option<crate::types::LanguageCode> {
&self.language_code
}
/// <p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>
pub fn vocabulary_state(mut self, input: crate::types::VocabularyState) -> Self {
self.vocabulary_state = ::std::option::Option::Some(input);
self
}
/// <p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>
pub fn set_vocabulary_state(mut self, input: ::std::option::Option<crate::types::VocabularyState>) -> Self {
self.vocabulary_state = input;
self
}
/// <p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>
pub fn get_vocabulary_state(&self) -> &::std::option::Option<crate::types::VocabularyState> {
&self.vocabulary_state
}
/// <p>The date and time the specified custom vocabulary was last modified.</p>
/// <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified_time = ::std::option::Option::Some(input);
self
}
/// <p>The date and time the specified custom vocabulary was last modified.</p>
/// <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified_time = input;
self
}
/// <p>The date and time the specified custom vocabulary was last modified.</p>
/// <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified_time
}
/// <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.failure_reason = ::std::option::Option::Some(input.into());
self
}
/// <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.failure_reason = input;
self
}
/// <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
&self.failure_reason
}
/// <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>
pub fn download_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.download_uri = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>
pub fn set_download_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.download_uri = input;
self
}
/// <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>
pub fn get_download_uri(&self) -> &::std::option::Option<::std::string::String> {
&self.download_uri
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`GetVocabularyOutput`](crate::operation::get_vocabulary::GetVocabularyOutput).
pub fn build(self) -> crate::operation::get_vocabulary::GetVocabularyOutput {
crate::operation::get_vocabulary::GetVocabularyOutput {
vocabulary_name: self.vocabulary_name,
language_code: self.language_code,
vocabulary_state: self.vocabulary_state,
last_modified_time: self.last_modified_time,
failure_reason: self.failure_reason,
download_uri: self.download_uri,
_request_id: self._request_id,
}
}
}