aws_sdk_textract/operation/get_lending_analysis/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_lending_analysis::_get_lending_analysis_output::GetLendingAnalysisOutputBuilder;
3
4pub use crate::operation::get_lending_analysis::_get_lending_analysis_input::GetLendingAnalysisInputBuilder;
5
6impl crate::operation::get_lending_analysis::builders::GetLendingAnalysisInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_lending_analysis::GetLendingAnalysisOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_lending_analysis::GetLendingAnalysisError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_lending_analysis();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetLendingAnalysis`.
24///
25/// <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.</p>
26/// <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>, which returns a job identifier (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to <code>StartLendingAnalysis</code>.</p>
27/// <p>To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartLendingAnalysis</code>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetLendingAnalysisFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_lending_analysis::builders::GetLendingAnalysisInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_lending_analysis::GetLendingAnalysisOutput,
37        crate::operation::get_lending_analysis::GetLendingAnalysisError,
38    > for GetLendingAnalysisFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::get_lending_analysis::GetLendingAnalysisOutput,
46            crate::operation::get_lending_analysis::GetLendingAnalysisError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetLendingAnalysisFluentBuilder {
53    /// Creates a new `GetLendingAnalysisFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the GetLendingAnalysis as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_lending_analysis::builders::GetLendingAnalysisInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::get_lending_analysis::GetLendingAnalysisOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_lending_analysis::GetLendingAnalysisError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::get_lending_analysis::GetLendingAnalysis::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_lending_analysis::GetLendingAnalysis::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::get_lending_analysis::GetLendingAnalysisOutput,
99        crate::operation::get_lending_analysis::GetLendingAnalysisError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
114    pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.job_id(input.into());
116        self
117    }
118    /// <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
119    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_job_id(input);
121        self
122    }
123    /// <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
124    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_job_id()
126    }
127    /// <p>The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.</p>
128    pub fn max_results(mut self, input: i32) -> Self {
129        self.inner = self.inner.max_results(input);
130        self
131    }
132    /// <p>The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.</p>
133    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
134        self.inner = self.inner.set_max_results(input);
135        self
136    }
137    /// <p>The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.</p>
138    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
139        self.inner.get_max_results()
140    }
141    /// <p>If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.</p>
142    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.next_token(input.into());
144        self
145    }
146    /// <p>If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.</p>
147    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_next_token(input);
149        self
150    }
151    /// <p>If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.</p>
152    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_next_token()
154    }
155}
aws_sdk_textract/operation/get_lending_analysis/builders.rs

aws_sdk_textract/operation/get_lending_analysis/
builders.rs
