aws_sdk_qbusiness/operation/batch_put_document/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_put_document::_batch_put_document_output::BatchPutDocumentOutputBuilder;
3
4pub use crate::operation::batch_put_document::_batch_put_document_input::BatchPutDocumentInputBuilder;
5
6impl crate::operation::batch_put_document::builders::BatchPutDocumentInputBuilder {
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::batch_put_document::BatchPutDocumentOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_put_document::BatchPutDocumentError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_put_document();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchPutDocument`.
24///
25/// <p>Adds one or more documents to an Amazon Q Business index.</p>
26/// <p>You use this API to:</p>
27/// <ul>
28/// <li>
29/// <p>ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.</p></li>
30/// <li>
31/// <p>add custom attributes to documents in an Amazon Q Business index.</p></li>
32/// <li>
33/// <p>attach an access control list to the documents added to an Amazon Q Business index.</p></li>
34/// </ul>
35/// <p>You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.</p>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct BatchPutDocumentFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::batch_put_document::builders::BatchPutDocumentInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::batch_put_document::BatchPutDocumentOutput,
45        crate::operation::batch_put_document::BatchPutDocumentError,
46    > for BatchPutDocumentFluentBuilder
47{
48    fn send(
49        self,
50        config_override: crate::config::Builder,
51    ) -> crate::client::customize::internal::BoxFuture<
52        crate::client::customize::internal::SendResult<
53            crate::operation::batch_put_document::BatchPutDocumentOutput,
54            crate::operation::batch_put_document::BatchPutDocumentError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl BatchPutDocumentFluentBuilder {
61    /// Creates a new `BatchPutDocumentFluentBuilder`.
62    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
63        Self {
64            handle,
65            inner: ::std::default::Default::default(),
66            config_override: ::std::option::Option::None,
67        }
68    }
69    /// Access the BatchPutDocument as a reference.
70    pub fn as_input(&self) -> &crate::operation::batch_put_document::builders::BatchPutDocumentInputBuilder {
71        &self.inner
72    }
73    /// Sends the request and returns the response.
74    ///
75    /// If an error occurs, an `SdkError` will be returned with additional details that
76    /// can be matched against.
77    ///
78    /// By default, any retryable failures will be retried twice. Retry behavior
79    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
80    /// set when configuring the client.
81    pub async fn send(
82        self,
83    ) -> ::std::result::Result<
84        crate::operation::batch_put_document::BatchPutDocumentOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::batch_put_document::BatchPutDocumentError,
87            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
88        >,
89    > {
90        let input = self
91            .inner
92            .build()
93            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
94        let runtime_plugins = crate::operation::batch_put_document::BatchPutDocument::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::batch_put_document::BatchPutDocument::orchestrate(&runtime_plugins, input).await
100    }
101
102    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
103    pub fn customize(
104        self,
105    ) -> crate::client::customize::CustomizableOperation<
106        crate::operation::batch_put_document::BatchPutDocumentOutput,
107        crate::operation::batch_put_document::BatchPutDocumentError,
108        Self,
109    > {
110        crate::client::customize::CustomizableOperation::new(self)
111    }
112    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
113        self.set_config_override(::std::option::Option::Some(config_override.into()));
114        self
115    }
116
117    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
118        self.config_override = config_override;
119        self
120    }
121    /// <p>The identifier of the Amazon Q Business application.</p>
122    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.application_id(input.into());
124        self
125    }
126    /// <p>The identifier of the Amazon Q Business application.</p>
127    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_application_id(input);
129        self
130    }
131    /// <p>The identifier of the Amazon Q Business application.</p>
132    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_application_id()
134    }
135    /// <p>The identifier of the Amazon Q Business index to add the documents to.</p>
136    pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.index_id(input.into());
138        self
139    }
140    /// <p>The identifier of the Amazon Q Business index to add the documents to.</p>
141    pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_index_id(input);
143        self
144    }
145    /// <p>The identifier of the Amazon Q Business index to add the documents to.</p>
146    pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_index_id()
148    }
149    ///
150    /// Appends an item to `documents`.
151    ///
152    /// To override the contents of this collection use [`set_documents`](Self::set_documents).
153    ///
154    /// <p>One or more documents to add to the index.</p><important>
155    /// <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p>
156    /// </important>
157    pub fn documents(mut self, input: crate::types::Document) -> Self {
158        self.inner = self.inner.documents(input);
159        self
160    }
161    /// <p>One or more documents to add to the index.</p><important>
162    /// <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p>
163    /// </important>
164    pub fn set_documents(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Document>>) -> Self {
165        self.inner = self.inner.set_documents(input);
166        self
167    }
168    /// <p>One or more documents to add to the index.</p><important>
169    /// <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p>
170    /// </important>
171    pub fn get_documents(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Document>> {
172        self.inner.get_documents()
173    }
174    /// <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p>
175    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
176        self.inner = self.inner.role_arn(input.into());
177        self
178    }
179    /// <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p>
180    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
181        self.inner = self.inner.set_role_arn(input);
182        self
183    }
184    /// <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p>
185    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
186        self.inner.get_role_arn()
187    }
188    /// <p>The identifier of the data source sync during which the documents were added.</p>
189    pub fn data_source_sync_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.data_source_sync_id(input.into());
191        self
192    }
193    /// <p>The identifier of the data source sync during which the documents were added.</p>
194    pub fn set_data_source_sync_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
195        self.inner = self.inner.set_data_source_sync_id(input);
196        self
197    }
198    /// <p>The identifier of the data source sync during which the documents were added.</p>
199    pub fn get_data_source_sync_id(&self) -> &::std::option::Option<::std::string::String> {
200        self.inner.get_data_source_sync_id()
201    }
202}
aws_sdk_qbusiness/operation/batch_put_document/builders.rs

aws_sdk_qbusiness/operation/batch_put_document/
builders.rs
