aws_sdk_workdocs/operation/create_comment/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_comment::_create_comment_output::CreateCommentOutputBuilder;
3
4pub use crate::operation::create_comment::_create_comment_input::CreateCommentInputBuilder;
5
6impl crate::operation::create_comment::builders::CreateCommentInputBuilder {
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::create_comment::CreateCommentOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_comment::CreateCommentError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_comment();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateComment`.
24///
25/// <p>Adds a new comment to the specified document version.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateCommentFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_comment::builders::CreateCommentInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_comment::CreateCommentOutput,
35        crate::operation::create_comment::CreateCommentError,
36    > for CreateCommentFluentBuilder
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::create_comment::CreateCommentOutput,
44            crate::operation::create_comment::CreateCommentError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateCommentFluentBuilder {
51    /// Creates a new `CreateCommentFluentBuilder`.
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 CreateComment as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_comment::builders::CreateCommentInputBuilder {
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::create_comment::CreateCommentOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_comment::CreateCommentError,
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::create_comment::CreateComment::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_comment::CreateComment::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::create_comment::CreateCommentOutput,
97        crate::operation::create_comment::CreateCommentError,
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    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
112    pub fn authentication_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.authentication_token(input.into());
114        self
115    }
116    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
117    pub fn set_authentication_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_authentication_token(input);
119        self
120    }
121    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
122    pub fn get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_authentication_token()
124    }
125    /// <p>The ID of the document.</p>
126    pub fn document_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.document_id(input.into());
128        self
129    }
130    /// <p>The ID of the document.</p>
131    pub fn set_document_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_document_id(input);
133        self
134    }
135    /// <p>The ID of the document.</p>
136    pub fn get_document_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_document_id()
138    }
139    /// <p>The ID of the document version.</p>
140    pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.version_id(input.into());
142        self
143    }
144    /// <p>The ID of the document version.</p>
145    pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_version_id(input);
147        self
148    }
149    /// <p>The ID of the document version.</p>
150    pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_version_id()
152    }
153    /// <p>The ID of the parent comment.</p>
154    pub fn parent_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.parent_id(input.into());
156        self
157    }
158    /// <p>The ID of the parent comment.</p>
159    pub fn set_parent_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_parent_id(input);
161        self
162    }
163    /// <p>The ID of the parent comment.</p>
164    pub fn get_parent_id(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_parent_id()
166    }
167    /// <p>The ID of the root comment in the thread.</p>
168    pub fn thread_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.thread_id(input.into());
170        self
171    }
172    /// <p>The ID of the root comment in the thread.</p>
173    pub fn set_thread_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_thread_id(input);
175        self
176    }
177    /// <p>The ID of the root comment in the thread.</p>
178    pub fn get_thread_id(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_thread_id()
180    }
181    /// <p>The text of the comment.</p>
182    pub fn text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183        self.inner = self.inner.text(input.into());
184        self
185    }
186    /// <p>The text of the comment.</p>
187    pub fn set_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_text(input);
189        self
190    }
191    /// <p>The text of the comment.</p>
192    pub fn get_text(&self) -> &::std::option::Option<::std::string::String> {
193        self.inner.get_text()
194    }
195    /// <p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>
196    pub fn visibility(mut self, input: crate::types::CommentVisibilityType) -> Self {
197        self.inner = self.inner.visibility(input);
198        self
199    }
200    /// <p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>
201    pub fn set_visibility(mut self, input: ::std::option::Option<crate::types::CommentVisibilityType>) -> Self {
202        self.inner = self.inner.set_visibility(input);
203        self
204    }
205    /// <p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>
206    pub fn get_visibility(&self) -> &::std::option::Option<crate::types::CommentVisibilityType> {
207        self.inner.get_visibility()
208    }
209    /// <p>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.</p>
210    pub fn notify_collaborators(mut self, input: bool) -> Self {
211        self.inner = self.inner.notify_collaborators(input);
212        self
213    }
214    /// <p>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.</p>
215    pub fn set_notify_collaborators(mut self, input: ::std::option::Option<bool>) -> Self {
216        self.inner = self.inner.set_notify_collaborators(input);
217        self
218    }
219    /// <p>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.</p>
220    pub fn get_notify_collaborators(&self) -> &::std::option::Option<bool> {
221        self.inner.get_notify_collaborators()
222    }
223}