aws_sdk_qbusiness/operation/get_document_content/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_document_content::_get_document_content_output::GetDocumentContentOutputBuilder;
3
4pub use crate::operation::get_document_content::_get_document_content_input::GetDocumentContentInputBuilder;
5
6impl crate::operation::get_document_content::builders::GetDocumentContentInputBuilder {
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_content::GetDocumentContentOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_document_content::GetDocumentContentError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_document_content();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetDocumentContent`.
24///
25/// <p>Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct GetDocumentContentFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::get_document_content::builders::GetDocumentContentInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::get_document_content::GetDocumentContentOutput,
35        crate::operation::get_document_content::GetDocumentContentError,
36    > for GetDocumentContentFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::get_document_content::GetDocumentContentOutput,
44            crate::operation::get_document_content::GetDocumentContentError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl GetDocumentContentFluentBuilder {
51    /// Creates a new `GetDocumentContentFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the GetDocumentContent as a reference.
60    pub fn as_input(&self) -> &crate::operation::get_document_content::builders::GetDocumentContentInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::get_document_content::GetDocumentContentOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::get_document_content::GetDocumentContentError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::get_document_content::GetDocumentContent::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::get_document_content::GetDocumentContent::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::get_document_content::GetDocumentContentOutput,
97        crate::operation::get_document_content::GetDocumentContentError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>
112    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.application_id(input.into());
114        self
115    }
116    /// <p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>
117    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_application_id(input);
119        self
120    }
121    /// <p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>
122    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_application_id()
124    }
125    /// <p>The identifier of the index where documents are indexed.</p>
126    pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.index_id(input.into());
128        self
129    }
130    /// <p>The identifier of the index where documents are indexed.</p>
131    pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_index_id(input);
133        self
134    }
135    /// <p>The identifier of the index where documents are indexed.</p>
136    pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_index_id()
138    }
139    /// <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
140    pub fn data_source_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.data_source_id(input.into());
142        self
143    }
144    /// <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
145    pub fn set_data_source_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_data_source_id(input);
147        self
148    }
149    /// <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
150    pub fn get_data_source_id(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_data_source_id()
152    }
153    /// <p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>
154    pub fn document_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.document_id(input.into());
156        self
157    }
158    /// <p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>
159    pub fn set_document_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_document_id(input);
161        self
162    }
163    /// <p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>
164    pub fn get_document_id(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_document_id()
166    }
167    /// <p>Document outputFormat. Defaults to RAW if not selected.</p>
168    pub fn output_format(mut self, input: crate::types::OutputFormat) -> Self {
169        self.inner = self.inner.output_format(input);
170        self
171    }
172    /// <p>Document outputFormat. Defaults to RAW if not selected.</p>
173    pub fn set_output_format(mut self, input: ::std::option::Option<crate::types::OutputFormat>) -> Self {
174        self.inner = self.inner.set_output_format(input);
175        self
176    }
177    /// <p>Document outputFormat. Defaults to RAW if not selected.</p>
178    pub fn get_output_format(&self) -> &::std::option::Option<crate::types::OutputFormat> {
179        self.inner.get_output_format()
180    }
181}