aws_sdk_workdocs/operation/describe_comments/
_describe_comments_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
5pub struct DescribeCommentsInput {
6    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
7    pub authentication_token: ::std::option::Option<::std::string::String>,
8    /// <p>The ID of the document.</p>
9    pub document_id: ::std::option::Option<::std::string::String>,
10    /// <p>The ID of the document version.</p>
11    pub version_id: ::std::option::Option<::std::string::String>,
12    /// <p>The maximum number of items to return.</p>
13    pub limit: ::std::option::Option<i32>,
14    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
15    pub marker: ::std::option::Option<::std::string::String>,
16}
17impl DescribeCommentsInput {
18    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
19    pub fn authentication_token(&self) -> ::std::option::Option<&str> {
20        self.authentication_token.as_deref()
21    }
22    /// <p>The ID of the document.</p>
23    pub fn document_id(&self) -> ::std::option::Option<&str> {
24        self.document_id.as_deref()
25    }
26    /// <p>The ID of the document version.</p>
27    pub fn version_id(&self) -> ::std::option::Option<&str> {
28        self.version_id.as_deref()
29    }
30    /// <p>The maximum number of items to return.</p>
31    pub fn limit(&self) -> ::std::option::Option<i32> {
32        self.limit
33    }
34    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
35    pub fn marker(&self) -> ::std::option::Option<&str> {
36        self.marker.as_deref()
37    }
38}
39impl ::std::fmt::Debug for DescribeCommentsInput {
40    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
41        let mut formatter = f.debug_struct("DescribeCommentsInput");
42        formatter.field("authentication_token", &"*** Sensitive Data Redacted ***");
43        formatter.field("document_id", &self.document_id);
44        formatter.field("version_id", &self.version_id);
45        formatter.field("limit", &self.limit);
46        formatter.field("marker", &self.marker);
47        formatter.finish()
48    }
49}
50impl DescribeCommentsInput {
51    /// Creates a new builder-style object to manufacture [`DescribeCommentsInput`](crate::operation::describe_comments::DescribeCommentsInput).
52    pub fn builder() -> crate::operation::describe_comments::builders::DescribeCommentsInputBuilder {
53        crate::operation::describe_comments::builders::DescribeCommentsInputBuilder::default()
54    }
55}
56
57/// A builder for [`DescribeCommentsInput`](crate::operation::describe_comments::DescribeCommentsInput).
58#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
59#[non_exhaustive]
60pub struct DescribeCommentsInputBuilder {
61    pub(crate) authentication_token: ::std::option::Option<::std::string::String>,
62    pub(crate) document_id: ::std::option::Option<::std::string::String>,
63    pub(crate) version_id: ::std::option::Option<::std::string::String>,
64    pub(crate) limit: ::std::option::Option<i32>,
65    pub(crate) marker: ::std::option::Option<::std::string::String>,
66}
67impl DescribeCommentsInputBuilder {
68    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
69    pub fn authentication_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
70        self.authentication_token = ::std::option::Option::Some(input.into());
71        self
72    }
73    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
74    pub fn set_authentication_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
75        self.authentication_token = input;
76        self
77    }
78    /// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
79    pub fn get_authentication_token(&self) -> &::std::option::Option<::std::string::String> {
80        &self.authentication_token
81    }
82    /// <p>The ID of the document.</p>
83    /// This field is required.
84    pub fn document_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
85        self.document_id = ::std::option::Option::Some(input.into());
86        self
87    }
88    /// <p>The ID of the document.</p>
89    pub fn set_document_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
90        self.document_id = input;
91        self
92    }
93    /// <p>The ID of the document.</p>
94    pub fn get_document_id(&self) -> &::std::option::Option<::std::string::String> {
95        &self.document_id
96    }
97    /// <p>The ID of the document version.</p>
98    /// This field is required.
99    pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
100        self.version_id = ::std::option::Option::Some(input.into());
101        self
102    }
103    /// <p>The ID of the document version.</p>
104    pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
105        self.version_id = input;
106        self
107    }
108    /// <p>The ID of the document version.</p>
109    pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
110        &self.version_id
111    }
112    /// <p>The maximum number of items to return.</p>
113    pub fn limit(mut self, input: i32) -> Self {
114        self.limit = ::std::option::Option::Some(input);
115        self
116    }
117    /// <p>The maximum number of items to return.</p>
118    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
119        self.limit = input;
120        self
121    }
122    /// <p>The maximum number of items to return.</p>
123    pub fn get_limit(&self) -> &::std::option::Option<i32> {
124        &self.limit
125    }
126    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
127    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.marker = ::std::option::Option::Some(input.into());
129        self
130    }
131    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
132    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.marker = input;
134        self
135    }
136    /// <p>The marker for the next set of results. This marker was received from a previous call.</p>
137    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
138        &self.marker
139    }
140    /// Consumes the builder and constructs a [`DescribeCommentsInput`](crate::operation::describe_comments::DescribeCommentsInput).
141    pub fn build(
142        self,
143    ) -> ::std::result::Result<crate::operation::describe_comments::DescribeCommentsInput, ::aws_smithy_types::error::operation::BuildError> {
144        ::std::result::Result::Ok(crate::operation::describe_comments::DescribeCommentsInput {
145            authentication_token: self.authentication_token,
146            document_id: self.document_id,
147            version_id: self.version_id,
148            limit: self.limit,
149            marker: self.marker,
150        })
151    }
152}
153impl ::std::fmt::Debug for DescribeCommentsInputBuilder {
154    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
155        let mut formatter = f.debug_struct("DescribeCommentsInputBuilder");
156        formatter.field("authentication_token", &"*** Sensitive Data Redacted ***");
157        formatter.field("document_id", &self.document_id);
158        formatter.field("version_id", &self.version_id);
159        formatter.field("limit", &self.limit);
160        formatter.field("marker", &self.marker);
161        formatter.finish()
162    }
163}
aws_sdk_workdocs/operation/describe_comments/_describe_comments_input.rs

aws_sdk_workdocs/operation/describe_comments/
_describe_comments_input.rs
