aws_sdk_workdocs/operation/get_document_path/
_get_document_path_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 GetDocumentPathInput {
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 maximum number of levels in the hierarchy to return.</p>
11    pub limit: ::std::option::Option<i32>,
12    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
13    pub fields: ::std::option::Option<::std::string::String>,
14    /// <p>This value is not supported.</p>
15    pub marker: ::std::option::Option<::std::string::String>,
16}
17impl GetDocumentPathInput {
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 maximum number of levels in the hierarchy to return.</p>
27    pub fn limit(&self) -> ::std::option::Option<i32> {
28        self.limit
29    }
30    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
31    pub fn fields(&self) -> ::std::option::Option<&str> {
32        self.fields.as_deref()
33    }
34    /// <p>This value is not supported.</p>
35    pub fn marker(&self) -> ::std::option::Option<&str> {
36        self.marker.as_deref()
37    }
38}
39impl ::std::fmt::Debug for GetDocumentPathInput {
40    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
41        let mut formatter = f.debug_struct("GetDocumentPathInput");
42        formatter.field("authentication_token", &"*** Sensitive Data Redacted ***");
43        formatter.field("document_id", &self.document_id);
44        formatter.field("limit", &self.limit);
45        formatter.field("fields", &self.fields);
46        formatter.field("marker", &self.marker);
47        formatter.finish()
48    }
49}
50impl GetDocumentPathInput {
51    /// Creates a new builder-style object to manufacture [`GetDocumentPathInput`](crate::operation::get_document_path::GetDocumentPathInput).
52    pub fn builder() -> crate::operation::get_document_path::builders::GetDocumentPathInputBuilder {
53        crate::operation::get_document_path::builders::GetDocumentPathInputBuilder::default()
54    }
55}
56
57/// A builder for [`GetDocumentPathInput`](crate::operation::get_document_path::GetDocumentPathInput).
58#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
59#[non_exhaustive]
60pub struct GetDocumentPathInputBuilder {
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) limit: ::std::option::Option<i32>,
64    pub(crate) fields: ::std::option::Option<::std::string::String>,
65    pub(crate) marker: ::std::option::Option<::std::string::String>,
66}
67impl GetDocumentPathInputBuilder {
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 maximum number of levels in the hierarchy to return.</p>
98    pub fn limit(mut self, input: i32) -> Self {
99        self.limit = ::std::option::Option::Some(input);
100        self
101    }
102    /// <p>The maximum number of levels in the hierarchy to return.</p>
103    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
104        self.limit = input;
105        self
106    }
107    /// <p>The maximum number of levels in the hierarchy to return.</p>
108    pub fn get_limit(&self) -> &::std::option::Option<i32> {
109        &self.limit
110    }
111    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
112    pub fn fields(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.fields = ::std::option::Option::Some(input.into());
114        self
115    }
116    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
117    pub fn set_fields(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.fields = input;
119        self
120    }
121    /// <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>
122    pub fn get_fields(&self) -> &::std::option::Option<::std::string::String> {
123        &self.fields
124    }
125    /// <p>This value is not supported.</p>
126    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.marker = ::std::option::Option::Some(input.into());
128        self
129    }
130    /// <p>This value is not supported.</p>
131    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.marker = input;
133        self
134    }
135    /// <p>This value is not supported.</p>
136    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
137        &self.marker
138    }
139    /// Consumes the builder and constructs a [`GetDocumentPathInput`](crate::operation::get_document_path::GetDocumentPathInput).
140    pub fn build(
141        self,
142    ) -> ::std::result::Result<crate::operation::get_document_path::GetDocumentPathInput, ::aws_smithy_types::error::operation::BuildError> {
143        ::std::result::Result::Ok(crate::operation::get_document_path::GetDocumentPathInput {
144            authentication_token: self.authentication_token,
145            document_id: self.document_id,
146            limit: self.limit,
147            fields: self.fields,
148            marker: self.marker,
149        })
150    }
151}
152impl ::std::fmt::Debug for GetDocumentPathInputBuilder {
153    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
154        let mut formatter = f.debug_struct("GetDocumentPathInputBuilder");
155        formatter.field("authentication_token", &"*** Sensitive Data Redacted ***");
156        formatter.field("document_id", &self.document_id);
157        formatter.field("limit", &self.limit);
158        formatter.field("fields", &self.fields);
159        formatter.field("marker", &self.marker);
160        formatter.finish()
161    }
162}
aws_sdk_workdocs/operation/get_document_path/_get_document_path_input.rs

aws_sdk_workdocs/operation/get_document_path/
_get_document_path_input.rs
