aws_sdk_workdocs/operation/describe_comments/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_comments::_describe_comments_output::DescribeCommentsOutputBuilder;
3
4pub use crate::operation::describe_comments::_describe_comments_input::DescribeCommentsInputBuilder;
5
6impl crate::operation::describe_comments::builders::DescribeCommentsInputBuilder {
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_comments::DescribeCommentsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_comments::DescribeCommentsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_comments();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeComments`.
24///
25/// <p>List all the comments for the specified document version.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeCommentsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_comments::builders::DescribeCommentsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_comments::DescribeCommentsOutput,
35        crate::operation::describe_comments::DescribeCommentsError,
36    > for DescribeCommentsFluentBuilder
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::describe_comments::DescribeCommentsOutput,
44            crate::operation::describe_comments::DescribeCommentsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeCommentsFluentBuilder {
51    /// Creates a new `DescribeCommentsFluentBuilder`.
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 DescribeComments as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_comments::builders::DescribeCommentsInputBuilder {
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::describe_comments::DescribeCommentsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_comments::DescribeCommentsError,
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::describe_comments::DescribeComments::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_comments::DescribeComments::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::describe_comments::DescribeCommentsOutput,
97        crate::operation::describe_comments::DescribeCommentsError,
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::describe_comments::paginator::DescribeCommentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::describe_comments::paginator::DescribeCommentsPaginator {
115        crate::operation::describe_comments::paginator::DescribeCommentsPaginator::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 ID of the document.</p>
132    pub fn document_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.document_id(input.into());
134        self
135    }
136    /// <p>The ID of the document.</p>
137    pub fn set_document_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_document_id(input);
139        self
140    }
141    /// <p>The ID of the document.</p>
142    pub fn get_document_id(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_document_id()
144    }
145    /// <p>The ID of the document version.</p>
146    pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147        self.inner = self.inner.version_id(input.into());
148        self
149    }
150    /// <p>The ID of the document version.</p>
151    pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152        self.inner = self.inner.set_version_id(input);
153        self
154    }
155    /// <p>The ID of the document version.</p>
156    pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
157        self.inner.get_version_id()
158    }
159    /// <p>The maximum number of items to return.</p>
160    pub fn limit(mut self, input: i32) -> Self {
161        self.inner = self.inner.limit(input);
162        self
163    }
164    /// <p>The maximum number of items to return.</p>
165    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
166        self.inner = self.inner.set_limit(input);
167        self
168    }
169    /// <p>The maximum number of items to return.</p>
170    pub fn get_limit(&self) -> &::std::option::Option<i32> {
171        self.inner.get_limit()
172    }
173    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
174    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175        self.inner = self.inner.marker(input.into());
176        self
177    }
178    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
179    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180        self.inner = self.inner.set_marker(input);
181        self
182    }
183    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
184    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
185        self.inner.get_marker()
186    }
187}
aws_sdk_workdocs/operation/describe_comments/builders.rs

aws_sdk_workdocs/operation/describe_comments/
builders.rs
