aws_sdk_workdocs/operation/search_resources/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::search_resources::_search_resources_output::SearchResourcesOutputBuilder;
3
4pub use crate::operation::search_resources::_search_resources_input::SearchResourcesInputBuilder;
5
6impl crate::operation::search_resources::builders::SearchResourcesInputBuilder {
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::search_resources::SearchResourcesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::search_resources::SearchResourcesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.search_resources();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SearchResources`.
24///
25/// <p>Searches metadata and the content of folders, documents, document versions, and comments.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct SearchResourcesFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::search_resources::builders::SearchResourcesInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::search_resources::SearchResourcesOutput,
35        crate::operation::search_resources::SearchResourcesError,
36    > for SearchResourcesFluentBuilder
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::search_resources::SearchResourcesOutput,
44            crate::operation::search_resources::SearchResourcesError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl SearchResourcesFluentBuilder {
51    /// Creates a new `SearchResourcesFluentBuilder`.
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 SearchResources as a reference.
60    pub fn as_input(&self) -> &crate::operation::search_resources::builders::SearchResourcesInputBuilder {
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::search_resources::SearchResourcesOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::search_resources::SearchResourcesError,
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::search_resources::SearchResources::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::search_resources::SearchResources::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::search_resources::SearchResourcesOutput,
97        crate::operation::search_resources::SearchResourcesError,
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    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::search_resources::paginator::SearchResourcesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::search_resources::paginator::SearchResourcesPaginator {
115        crate::operation::search_resources::paginator::SearchResourcesPaginator::new(self.handle, self.inner)
116    }
117    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
118    pub fn authentication_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.authentication_token(input.into());
120        self
121    }
122    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
123    pub fn set_authentication_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_authentication_token(input);
125        self
126    }
127    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
128    pub fn get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_authentication_token()
130    }
131    /// <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
132    pub fn query_text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.query_text(input.into());
134        self
135    }
136    /// <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
137    pub fn set_query_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_query_text(input);
139        self
140    }
141    /// <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
142    pub fn get_query_text(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_query_text()
144    }
145    ///
146    /// Appends an item to `QueryScopes`.
147    ///
148    /// To override the contents of this collection use [`set_query_scopes`](Self::set_query_scopes).
149    ///
150    /// <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
151    pub fn query_scopes(mut self, input: crate::types::SearchQueryScopeType) -> Self {
152        self.inner = self.inner.query_scopes(input);
153        self
154    }
155    /// <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
156    pub fn set_query_scopes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SearchQueryScopeType>>) -> Self {
157        self.inner = self.inner.set_query_scopes(input);
158        self
159    }
160    /// <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
161    pub fn get_query_scopes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SearchQueryScopeType>> {
162        self.inner.get_query_scopes()
163    }
164    /// <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
165    pub fn organization_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166        self.inner = self.inner.organization_id(input.into());
167        self
168    }
169    /// <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
170    pub fn set_organization_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171        self.inner = self.inner.set_organization_id(input);
172        self
173    }
174    /// <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
175    pub fn get_organization_id(&self) -> &::std::option::Option<::std::string::String> {
176        self.inner.get_organization_id()
177    }
178    ///
179    /// Appends an item to `AdditionalResponseFields`.
180    ///
181    /// To override the contents of this collection use [`set_additional_response_fields`](Self::set_additional_response_fields).
182    ///
183    /// <p>A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.</p>
184    pub fn additional_response_fields(mut self, input: crate::types::AdditionalResponseFieldType) -> Self {
185        self.inner = self.inner.additional_response_fields(input);
186        self
187    }
188    /// <p>A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.</p>
189    pub fn set_additional_response_fields(
190        mut self,
191        input: ::std::option::Option<::std::vec::Vec<crate::types::AdditionalResponseFieldType>>,
192    ) -> Self {
193        self.inner = self.inner.set_additional_response_fields(input);
194        self
195    }
196    /// <p>A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.</p>
197    pub fn get_additional_response_fields(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AdditionalResponseFieldType>> {
198        self.inner.get_additional_response_fields()
199    }
200    /// <p>Filters results based on entity metadata.</p>
201    pub fn filters(mut self, input: crate::types::Filters) -> Self {
202        self.inner = self.inner.filters(input);
203        self
204    }
205    /// <p>Filters results based on entity metadata.</p>
206    pub fn set_filters(mut self, input: ::std::option::Option<crate::types::Filters>) -> Self {
207        self.inner = self.inner.set_filters(input);
208        self
209    }
210    /// <p>Filters results based on entity metadata.</p>
211    pub fn get_filters(&self) -> &::std::option::Option<crate::types::Filters> {
212        self.inner.get_filters()
213    }
214    ///
215    /// Appends an item to `OrderBy`.
216    ///
217    /// To override the contents of this collection use [`set_order_by`](Self::set_order_by).
218    ///
219    /// <p>Order by results in one or more categories.</p>
220    pub fn order_by(mut self, input: crate::types::SearchSortResult) -> Self {
221        self.inner = self.inner.order_by(input);
222        self
223    }
224    /// <p>Order by results in one or more categories.</p>
225    pub fn set_order_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SearchSortResult>>) -> Self {
226        self.inner = self.inner.set_order_by(input);
227        self
228    }
229    /// <p>Order by results in one or more categories.</p>
230    pub fn get_order_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SearchSortResult>> {
231        self.inner.get_order_by()
232    }
233    /// <p>Max results count per page.</p>
234    pub fn limit(mut self, input: i32) -> Self {
235        self.inner = self.inner.limit(input);
236        self
237    }
238    /// <p>Max results count per page.</p>
239    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
240        self.inner = self.inner.set_limit(input);
241        self
242    }
243    /// <p>Max results count per page.</p>
244    pub fn get_limit(&self) -> &::std::option::Option<i32> {
245        self.inner.get_limit()
246    }
247    /// <p>The marker for the next set of results.</p>
248    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
249        self.inner = self.inner.marker(input.into());
250        self
251    }
252    /// <p>The marker for the next set of results.</p>
253    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
254        self.inner = self.inner.set_marker(input);
255        self
256    }
257    /// <p>The marker for the next set of results.</p>
258    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
259        self.inner.get_marker()
260    }
261}
aws_sdk_workdocs/operation/search_resources/builders.rs

aws_sdk_workdocs/operation/search_resources/
builders.rs
