aws_sdk_textract/operation/get_document_text_detection/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_document_text_detection::_get_document_text_detection_output::GetDocumentTextDetectionOutputBuilder;
3
4pub use crate::operation::get_document_text_detection::_get_document_text_detection_input::GetDocumentTextDetectionInputBuilder;
5
6impl crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionInputBuilder {
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_document_text_detection::GetDocumentTextDetectionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_document_text_detection::GetDocumentTextDetectionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_document_text_detection();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetDocumentTextDetection`.
24///
25/// <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.</p>
26/// <p>You start asynchronous text detection by calling <code>StartDocumentTextDetection</code>, which returns a job identifier (<code>JobId</code>). When the text detection 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>StartDocumentTextDetection</code>. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetDocumentTextDetection</code>, and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartDocumentTextDetection</code>.</p>
27/// <p><code>GetDocumentTextDetection</code> returns an array of <code>Block</code> objects.</p>
28/// <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
29/// <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetDocumentTextDetection</code>, and populate the <code>NextToken</code> request parameter with the token value that's returned from the previous call to <code>GetDocumentTextDetection</code>.</p>
30/// <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct GetDocumentTextDetectionFluentBuilder {
33 handle: ::std::sync::Arc<crate::client::Handle>,
34 inner: crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionInputBuilder,
35 config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38 crate::client::customize::internal::CustomizableSend<
39 crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput,
40 crate::operation::get_document_text_detection::GetDocumentTextDetectionError,
41 > for GetDocumentTextDetectionFluentBuilder
42{
43 fn send(
44 self,
45 config_override: crate::config::Builder,
46 ) -> crate::client::customize::internal::BoxFuture<
47 crate::client::customize::internal::SendResult<
48 crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput,
49 crate::operation::get_document_text_detection::GetDocumentTextDetectionError,
50 >,
51 > {
52 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53 }
54}
55impl GetDocumentTextDetectionFluentBuilder {
56 /// Creates a new `GetDocumentTextDetectionFluentBuilder`.
57 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58 Self {
59 handle,
60 inner: ::std::default::Default::default(),
61 config_override: ::std::option::Option::None,
62 }
63 }
64 /// Access the GetDocumentTextDetection as a reference.
65 pub fn as_input(&self) -> &crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionInputBuilder {
66 &self.inner
67 }
68 /// Sends the request and returns the response.
69 ///
70 /// If an error occurs, an `SdkError` will be returned with additional details that
71 /// can be matched against.
72 ///
73 /// By default, any retryable failures will be retried twice. Retry behavior
74 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75 /// set when configuring the client.
76 pub async fn send(
77 self,
78 ) -> ::std::result::Result<
79 crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput,
80 ::aws_smithy_runtime_api::client::result::SdkError<
81 crate::operation::get_document_text_detection::GetDocumentTextDetectionError,
82 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83 >,
84 > {
85 let input = self
86 .inner
87 .build()
88 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89 let runtime_plugins = crate::operation::get_document_text_detection::GetDocumentTextDetection::operation_runtime_plugins(
90 self.handle.runtime_plugins.clone(),
91 &self.handle.conf,
92 self.config_override,
93 );
94 crate::operation::get_document_text_detection::GetDocumentTextDetection::orchestrate(&runtime_plugins, input).await
95 }
96
97 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98 pub fn customize(
99 self,
100 ) -> crate::client::customize::CustomizableOperation<
101 crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput,
102 crate::operation::get_document_text_detection::GetDocumentTextDetectionError,
103 Self,
104 > {
105 crate::client::customize::CustomizableOperation::new(self)
106 }
107 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108 self.set_config_override(::std::option::Option::Some(config_override.into()));
109 self
110 }
111
112 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113 self.config_override = config_override;
114 self
115 }
116 /// <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p>
117 pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118 self.inner = self.inner.job_id(input.into());
119 self
120 }
121 /// <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p>
122 pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123 self.inner = self.inner.set_job_id(input);
124 self
125 }
126 /// <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p>
127 pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
128 self.inner.get_job_id()
129 }
130 /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</p>
131 pub fn max_results(mut self, input: i32) -> Self {
132 self.inner = self.inner.max_results(input);
133 self
134 }
135 /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</p>
136 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
137 self.inner = self.inner.set_max_results(input);
138 self
139 }
140 /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</p>
141 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
142 self.inner.get_max_results()
143 }
144 /// <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
145 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
146 self.inner = self.inner.next_token(input.into());
147 self
148 }
149 /// <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
150 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
151 self.inner = self.inner.set_next_token(input);
152 self
153 }
154 /// <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
155 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
156 self.inner.get_next_token()
157 }
158}