aws_sdk_quicksight/operation/search_dashboards/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::search_dashboards::_search_dashboards_output::SearchDashboardsOutputBuilder;
3
4pub use crate::operation::search_dashboards::_search_dashboards_input::SearchDashboardsInputBuilder;
5
6impl crate::operation::search_dashboards::builders::SearchDashboardsInputBuilder {
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_dashboards::SearchDashboardsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::search_dashboards::SearchDashboardsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.search_dashboards();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SearchDashboards`.
24///
25/// <p>Searches for dashboards that belong to a user.</p><note>
26/// <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct SearchDashboardsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::search_dashboards::builders::SearchDashboardsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::search_dashboards::SearchDashboardsOutput,
37        crate::operation::search_dashboards::SearchDashboardsError,
38    > for SearchDashboardsFluentBuilder
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::search_dashboards::SearchDashboardsOutput,
46            crate::operation::search_dashboards::SearchDashboardsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl SearchDashboardsFluentBuilder {
53    /// Creates a new `SearchDashboardsFluentBuilder`.
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 SearchDashboards as a reference.
62    pub fn as_input(&self) -> &crate::operation::search_dashboards::builders::SearchDashboardsInputBuilder {
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::search_dashboards::SearchDashboardsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::search_dashboards::SearchDashboardsError,
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::search_dashboards::SearchDashboards::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::search_dashboards::SearchDashboards::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::search_dashboards::SearchDashboardsOutput,
99        crate::operation::search_dashboards::SearchDashboardsError,
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    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::search_dashboards::paginator::SearchDashboardsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::search_dashboards::paginator::SearchDashboardsPaginator {
117        crate::operation::search_dashboards::paginator::SearchDashboardsPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.</p>
120    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.aws_account_id(input.into());
122        self
123    }
124    /// <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.</p>
125    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_aws_account_id(input);
127        self
128    }
129    /// <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.</p>
130    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_aws_account_id()
132    }
133    ///
134    /// Appends an item to `Filters`.
135    ///
136    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
137    ///
138    /// <p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>"Filters": \[ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } \]</code></p>
139    pub fn filters(mut self, input: crate::types::DashboardSearchFilter) -> Self {
140        self.inner = self.inner.filters(input);
141        self
142    }
143    /// <p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>"Filters": \[ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } \]</code></p>
144    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DashboardSearchFilter>>) -> Self {
145        self.inner = self.inner.set_filters(input);
146        self
147    }
148    /// <p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>"Filters": \[ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } \]</code></p>
149    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DashboardSearchFilter>> {
150        self.inner.get_filters()
151    }
152    /// <p>The token for the next set of results, or null if there are no more results.</p>
153    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.inner = self.inner.next_token(input.into());
155        self
156    }
157    /// <p>The token for the next set of results, or null if there are no more results.</p>
158    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159        self.inner = self.inner.set_next_token(input);
160        self
161    }
162    /// <p>The token for the next set of results, or null if there are no more results.</p>
163    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_next_token()
165    }
166    /// <p>The maximum number of results to be returned per request.</p>
167    pub fn max_results(mut self, input: i32) -> Self {
168        self.inner = self.inner.max_results(input);
169        self
170    }
171    /// <p>The maximum number of results to be returned per request.</p>
172    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
173        self.inner = self.inner.set_max_results(input);
174        self
175    }
176    /// <p>The maximum number of results to be returned per request.</p>
177    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
178        self.inner.get_max_results()
179    }
180}
aws_sdk_quicksight/operation/search_dashboards/builders.rs

aws_sdk_quicksight/operation/search_dashboards/
builders.rs
