aws_sdk_kendra/operation/batch_delete_document/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_delete_document::_batch_delete_document_output::BatchDeleteDocumentOutputBuilder;
3
4pub use crate::operation::batch_delete_document::_batch_delete_document_input::BatchDeleteDocumentInputBuilder;
5
6impl crate::operation::batch_delete_document::builders::BatchDeleteDocumentInputBuilder {
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_delete_document::BatchDeleteDocumentOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_delete_document::BatchDeleteDocumentError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_delete_document();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchDeleteDocument`.
24///
25/// <p>Removes one or more documents from an index. The documents must have been added with the <code>BatchPutDocument</code> API.</p>
26/// <p>The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the <code>BatchGetDocumentStatus</code> API to monitor the progress of deleting your documents.</p>
27/// <p>Deleting documents from an index using <code>BatchDeleteDocument</code> could take up to an hour or more, depending on the number of documents you want to delete.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct BatchDeleteDocumentFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::batch_delete_document::builders::BatchDeleteDocumentInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::batch_delete_document::BatchDeleteDocumentOutput,
37        crate::operation::batch_delete_document::BatchDeleteDocumentError,
38    > for BatchDeleteDocumentFluentBuilder
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::batch_delete_document::BatchDeleteDocumentOutput,
46            crate::operation::batch_delete_document::BatchDeleteDocumentError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl BatchDeleteDocumentFluentBuilder {
53    /// Creates a new `BatchDeleteDocumentFluentBuilder`.
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 BatchDeleteDocument as a reference.
62    pub fn as_input(&self) -> &crate::operation::batch_delete_document::builders::BatchDeleteDocumentInputBuilder {
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::batch_delete_document::BatchDeleteDocumentOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::batch_delete_document::BatchDeleteDocumentError,
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::batch_delete_document::BatchDeleteDocument::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::batch_delete_document::BatchDeleteDocument::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::batch_delete_document::BatchDeleteDocumentOutput,
99        crate::operation::batch_delete_document::BatchDeleteDocumentError,
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>The identifier of the index that contains the documents to delete.</p>
114    pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.index_id(input.into());
116        self
117    }
118    /// <p>The identifier of the index that contains the documents to delete.</p>
119    pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_index_id(input);
121        self
122    }
123    /// <p>The identifier of the index that contains the documents to delete.</p>
124    pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_index_id()
126    }
127    ///
128    /// Appends an item to `DocumentIdList`.
129    ///
130    /// To override the contents of this collection use [`set_document_id_list`](Self::set_document_id_list).
131    ///
132    /// <p>One or more identifiers for documents to delete from the index.</p>
133    pub fn document_id_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.document_id_list(input.into());
135        self
136    }
137    /// <p>One or more identifiers for documents to delete from the index.</p>
138    pub fn set_document_id_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
139        self.inner = self.inner.set_document_id_list(input);
140        self
141    }
142    /// <p>One or more identifiers for documents to delete from the index.</p>
143    pub fn get_document_id_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
144        self.inner.get_document_id_list()
145    }
146    /// <p>Maps a particular data source sync job to a particular data source.</p>
147    pub fn data_source_sync_job_metric_target(mut self, input: crate::types::DataSourceSyncJobMetricTarget) -> Self {
148        self.inner = self.inner.data_source_sync_job_metric_target(input);
149        self
150    }
151    /// <p>Maps a particular data source sync job to a particular data source.</p>
152    pub fn set_data_source_sync_job_metric_target(mut self, input: ::std::option::Option<crate::types::DataSourceSyncJobMetricTarget>) -> Self {
153        self.inner = self.inner.set_data_source_sync_job_metric_target(input);
154        self
155    }
156    /// <p>Maps a particular data source sync job to a particular data source.</p>
157    pub fn get_data_source_sync_job_metric_target(&self) -> &::std::option::Option<crate::types::DataSourceSyncJobMetricTarget> {
158        self.inner.get_data_source_sync_job_metric_target()
159    }
160}
aws_sdk_kendra/operation/batch_delete_document/builders.rs

aws_sdk_kendra/operation/batch_delete_document/
builders.rs
