aws_sdk_workdocs/operation/describe_folder_contents/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_folder_contents::_describe_folder_contents_output::DescribeFolderContentsOutputBuilder;
3
4pub use crate::operation::describe_folder_contents::_describe_folder_contents_input::DescribeFolderContentsInputBuilder;
5
6impl crate::operation::describe_folder_contents::builders::DescribeFolderContentsInputBuilder {
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_folder_contents::DescribeFolderContentsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_folder_contents::DescribeFolderContentsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_folder_contents();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeFolderContents`.
24///
25/// <p>Describes the contents of the specified folder, including its documents and subfolders.</p>
26/// <p>By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeFolderContentsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_folder_contents::builders::DescribeFolderContentsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_folder_contents::DescribeFolderContentsOutput,
36        crate::operation::describe_folder_contents::DescribeFolderContentsError,
37    > for DescribeFolderContentsFluentBuilder
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_folder_contents::DescribeFolderContentsOutput,
45            crate::operation::describe_folder_contents::DescribeFolderContentsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeFolderContentsFluentBuilder {
52    /// Creates a new `DescribeFolderContentsFluentBuilder`.
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 DescribeFolderContents as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_folder_contents::builders::DescribeFolderContentsInputBuilder {
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_folder_contents::DescribeFolderContentsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_folder_contents::DescribeFolderContentsError,
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_folder_contents::DescribeFolderContents::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_folder_contents::DescribeFolderContents::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_folder_contents::DescribeFolderContentsOutput,
98        crate::operation::describe_folder_contents::DescribeFolderContentsError,
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_folder_contents::paginator::DescribeFolderContentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_folder_contents::paginator::DescribeFolderContentsPaginator {
116        crate::operation::describe_folder_contents::paginator::DescribeFolderContentsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</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. Not required when using Amazon Web Services administrator credentials to access the API.</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. Not required when using Amazon Web Services administrator credentials to access the API.</p>
129    pub fn get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_authentication_token()
131    }
132    /// <p>The ID of the folder.</p>
133    pub fn folder_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.folder_id(input.into());
135        self
136    }
137    /// <p>The ID of the folder.</p>
138    pub fn set_folder_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139        self.inner = self.inner.set_folder_id(input);
140        self
141    }
142    /// <p>The ID of the folder.</p>
143    pub fn get_folder_id(&self) -> &::std::option::Option<::std::string::String> {
144        self.inner.get_folder_id()
145    }
146    /// <p>The sorting criteria.</p>
147    pub fn sort(mut self, input: crate::types::ResourceSortType) -> Self {
148        self.inner = self.inner.sort(input);
149        self
150    }
151    /// <p>The sorting criteria.</p>
152    pub fn set_sort(mut self, input: ::std::option::Option<crate::types::ResourceSortType>) -> Self {
153        self.inner = self.inner.set_sort(input);
154        self
155    }
156    /// <p>The sorting criteria.</p>
157    pub fn get_sort(&self) -> &::std::option::Option<crate::types::ResourceSortType> {
158        self.inner.get_sort()
159    }
160    /// <p>The order for the contents of the folder.</p>
161    pub fn order(mut self, input: crate::types::OrderType) -> Self {
162        self.inner = self.inner.order(input);
163        self
164    }
165    /// <p>The order for the contents of the folder.</p>
166    pub fn set_order(mut self, input: ::std::option::Option<crate::types::OrderType>) -> Self {
167        self.inner = self.inner.set_order(input);
168        self
169    }
170    /// <p>The order for the contents of the folder.</p>
171    pub fn get_order(&self) -> &::std::option::Option<crate::types::OrderType> {
172        self.inner.get_order()
173    }
174    /// <p>The maximum number of items to return with this call.</p>
175    pub fn limit(mut self, input: i32) -> Self {
176        self.inner = self.inner.limit(input);
177        self
178    }
179    /// <p>The maximum number of items to return with this call.</p>
180    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
181        self.inner = self.inner.set_limit(input);
182        self
183    }
184    /// <p>The maximum number of items to return with this call.</p>
185    pub fn get_limit(&self) -> &::std::option::Option<i32> {
186        self.inner.get_limit()
187    }
188    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
189    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.marker(input.into());
191        self
192    }
193    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
194    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
195        self.inner = self.inner.set_marker(input);
196        self
197    }
198    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
199    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
200        self.inner.get_marker()
201    }
202    /// <p>The type of items.</p>
203    pub fn r#type(mut self, input: crate::types::FolderContentType) -> Self {
204        self.inner = self.inner.r#type(input);
205        self
206    }
207    /// <p>The type of items.</p>
208    pub fn set_type(mut self, input: ::std::option::Option<crate::types::FolderContentType>) -> Self {
209        self.inner = self.inner.set_type(input);
210        self
211    }
212    /// <p>The type of items.</p>
213    pub fn get_type(&self) -> &::std::option::Option<crate::types::FolderContentType> {
214        self.inner.get_type()
215    }
216    /// <p>The contents to include. Specify "INITIALIZED" to include initialized documents.</p>
217    pub fn include(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
218        self.inner = self.inner.include(input.into());
219        self
220    }
221    /// <p>The contents to include. Specify "INITIALIZED" to include initialized documents.</p>
222    pub fn set_include(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
223        self.inner = self.inner.set_include(input);
224        self
225    }
226    /// <p>The contents to include. Specify "INITIALIZED" to include initialized documents.</p>
227    pub fn get_include(&self) -> &::std::option::Option<::std::string::String> {
228        self.inner.get_include()
229    }
230}
aws_sdk_workdocs/operation/describe_folder_contents/builders.rs

aws_sdk_workdocs/operation/describe_folder_contents/
builders.rs
