aws_sdk_workdocs/operation/describe_root_folders/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_root_folders::_describe_root_folders_output::DescribeRootFoldersOutputBuilder;
3
4pub use crate::operation::describe_root_folders::_describe_root_folders_input::DescribeRootFoldersInputBuilder;
5
6impl crate::operation::describe_root_folders::builders::DescribeRootFoldersInputBuilder {
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::describe_root_folders::DescribeRootFoldersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_root_folders::DescribeRootFoldersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_root_folders();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeRootFolders`.
24///
25/// <p>Describes the current user's special folders; the <code>RootFolder</code> and the <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.</p>
26/// <p>This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access Control for User Applications</a> in the <i>Amazon WorkDocs Developer Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeRootFoldersFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_root_folders::builders::DescribeRootFoldersInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_root_folders::DescribeRootFoldersOutput,
36        crate::operation::describe_root_folders::DescribeRootFoldersError,
37    > for DescribeRootFoldersFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::describe_root_folders::DescribeRootFoldersOutput,
45            crate::operation::describe_root_folders::DescribeRootFoldersError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeRootFoldersFluentBuilder {
52    /// Creates a new `DescribeRootFoldersFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the DescribeRootFolders as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_root_folders::builders::DescribeRootFoldersInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::describe_root_folders::DescribeRootFoldersOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_root_folders::DescribeRootFoldersError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::describe_root_folders::DescribeRootFolders::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_root_folders::DescribeRootFolders::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::describe_root_folders::DescribeRootFoldersOutput,
98        crate::operation::describe_root_folders::DescribeRootFoldersError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::describe_root_folders::paginator::DescribeRootFoldersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_root_folders::paginator::DescribeRootFoldersPaginator {
116        crate::operation::describe_root_folders::paginator::DescribeRootFoldersPaginator::new(self.handle, self.inner)
117    }
118    /// <p>Amazon WorkDocs authentication token.</p>
119    pub fn authentication_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.authentication_token(input.into());
121        self
122    }
123    /// <p>Amazon WorkDocs authentication token.</p>
124    pub fn set_authentication_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_authentication_token(input);
126        self
127    }
128    /// <p>Amazon WorkDocs authentication token.</p>
129    pub fn get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_authentication_token()
131    }
132    /// <p>The maximum number of items to return.</p>
133    pub fn limit(mut self, input: i32) -> Self {
134        self.inner = self.inner.limit(input);
135        self
136    }
137    /// <p>The maximum number of items to return.</p>
138    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
139        self.inner = self.inner.set_limit(input);
140        self
141    }
142    /// <p>The maximum number of items to return.</p>
143    pub fn get_limit(&self) -> &::std::option::Option<i32> {
144        self.inner.get_limit()
145    }
146    /// <p>The marker for the next set of results. (You received this marker from a previous call.)</p>
147    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.marker(input.into());
149        self
150    }
151    /// <p>The marker for the next set of results. (You received this marker from a previous call.)</p>
152    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153        self.inner = self.inner.set_marker(input);
154        self
155    }
156    /// <p>The marker for the next set of results. (You received this marker from a previous call.)</p>
157    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
158        self.inner.get_marker()
159    }
160}