aws_sdk_workdocs/operation/get_document_path/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_document_path::_get_document_path_output::GetDocumentPathOutputBuilder;
3
4pub use crate::operation::get_document_path::_get_document_path_input::GetDocumentPathInputBuilder;
5
6impl crate::operation::get_document_path::builders::GetDocumentPathInputBuilder {
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::get_document_path::GetDocumentPathOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_document_path::GetDocumentPathError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_document_path();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetDocumentPath`.
24///
25/// <p>Retrieves the path information (the hierarchy from the root folder) for the requested document.</p>
26/// <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct GetDocumentPathFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::get_document_path::builders::GetDocumentPathInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::get_document_path::GetDocumentPathOutput,
36        crate::operation::get_document_path::GetDocumentPathError,
37    > for GetDocumentPathFluentBuilder
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::get_document_path::GetDocumentPathOutput,
45            crate::operation::get_document_path::GetDocumentPathError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl GetDocumentPathFluentBuilder {
52    /// Creates a new `GetDocumentPathFluentBuilder`.
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 GetDocumentPath as a reference.
61    pub fn as_input(&self) -> &crate::operation::get_document_path::builders::GetDocumentPathInputBuilder {
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::get_document_path::GetDocumentPathOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::get_document_path::GetDocumentPathError,
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::get_document_path::GetDocumentPath::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::get_document_path::GetDocumentPath::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::get_document_path::GetDocumentPathOutput,
98        crate::operation::get_document_path::GetDocumentPathError,
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    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
113    pub fn authentication_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.authentication_token(input.into());
115        self
116    }
117    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
118    pub fn set_authentication_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_authentication_token(input);
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 get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_authentication_token()
125    }
126    /// <p>The ID of the document.</p>
127    pub fn document_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.document_id(input.into());
129        self
130    }
131    /// <p>The ID of the document.</p>
132    pub fn set_document_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_document_id(input);
134        self
135    }
136    /// <p>The ID of the document.</p>
137    pub fn get_document_id(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_document_id()
139    }
140    /// <p>The maximum number of levels in the hierarchy to return.</p>
141    pub fn limit(mut self, input: i32) -> Self {
142        self.inner = self.inner.limit(input);
143        self
144    }
145    /// <p>The maximum number of levels in the hierarchy to return.</p>
146    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
147        self.inner = self.inner.set_limit(input);
148        self
149    }
150    /// <p>The maximum number of levels in the hierarchy to return.</p>
151    pub fn get_limit(&self) -> &::std::option::Option<i32> {
152        self.inner.get_limit()
153    }
154    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
155    pub fn fields(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
156        self.inner = self.inner.fields(input.into());
157        self
158    }
159    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
160    pub fn set_fields(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
161        self.inner = self.inner.set_fields(input);
162        self
163    }
164    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
165    pub fn get_fields(&self) -> &::std::option::Option<::std::string::String> {
166        self.inner.get_fields()
167    }
168    /// <p>This value is not supported.</p>
169    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170        self.inner = self.inner.marker(input.into());
171        self
172    }
173    /// <p>This value is not supported.</p>
174    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
175        self.inner = self.inner.set_marker(input);
176        self
177    }
178    /// <p>This value is not supported.</p>
179    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
180        self.inner.get_marker()
181    }
182}
aws_sdk_workdocs/operation/get_document_path/builders.rs

aws_sdk_workdocs/operation/get_document_path/
builders.rs
