1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetCatalogsInput {
/// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
pub parent_catalog_id: ::std::option::Option<::std::string::String>,
/// <p>A continuation token, if this is a continuation call.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of catalogs to return in one response.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
pub recursive: ::std::option::Option<bool>,
/// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
/// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
pub include_root: ::std::option::Option<bool>,
/// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
pub has_databases: ::std::option::Option<bool>,
}
impl GetCatalogsInput {
/// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
pub fn parent_catalog_id(&self) -> ::std::option::Option<&str> {
self.parent_catalog_id.as_deref()
}
/// <p>A continuation token, if this is a continuation call.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of catalogs to return in one response.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
pub fn recursive(&self) -> ::std::option::Option<bool> {
self.recursive
}
/// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
/// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
pub fn include_root(&self) -> ::std::option::Option<bool> {
self.include_root
}
/// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
pub fn has_databases(&self) -> ::std::option::Option<bool> {
self.has_databases
}
}
impl GetCatalogsInput {
/// Creates a new builder-style object to manufacture [`GetCatalogsInput`](crate::operation::get_catalogs::GetCatalogsInput).
pub fn builder() -> crate::operation::get_catalogs::builders::GetCatalogsInputBuilder {
crate::operation::get_catalogs::builders::GetCatalogsInputBuilder::default()
}
}
/// A builder for [`GetCatalogsInput`](crate::operation::get_catalogs::GetCatalogsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetCatalogsInputBuilder {
pub(crate) parent_catalog_id: ::std::option::Option<::std::string::String>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) recursive: ::std::option::Option<bool>,
pub(crate) include_root: ::std::option::Option<bool>,
pub(crate) has_databases: ::std::option::Option<bool>,
}
impl GetCatalogsInputBuilder {
/// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
pub fn parent_catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.parent_catalog_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
pub fn set_parent_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.parent_catalog_id = input;
self
}
/// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
pub fn get_parent_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
&self.parent_catalog_id
}
/// <p>A continuation token, if this is a continuation call.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A continuation token, if this is a continuation call.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>A continuation token, if this is a continuation call.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of catalogs to return in one response.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of catalogs to return in one response.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of catalogs to return in one response.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
pub fn recursive(mut self, input: bool) -> Self {
self.recursive = ::std::option::Option::Some(input);
self
}
/// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
pub fn set_recursive(mut self, input: ::std::option::Option<bool>) -> Self {
self.recursive = input;
self
}
/// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
pub fn get_recursive(&self) -> &::std::option::Option<bool> {
&self.recursive
}
/// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
/// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
pub fn include_root(mut self, input: bool) -> Self {
self.include_root = ::std::option::Option::Some(input);
self
}
/// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
/// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
pub fn set_include_root(mut self, input: ::std::option::Option<bool>) -> Self {
self.include_root = input;
self
}
/// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
/// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
pub fn get_include_root(&self) -> &::std::option::Option<bool> {
&self.include_root
}
/// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
pub fn has_databases(mut self, input: bool) -> Self {
self.has_databases = ::std::option::Option::Some(input);
self
}
/// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
pub fn set_has_databases(mut self, input: ::std::option::Option<bool>) -> Self {
self.has_databases = input;
self
}
/// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
pub fn get_has_databases(&self) -> &::std::option::Option<bool> {
&self.has_databases
}
/// Consumes the builder and constructs a [`GetCatalogsInput`](crate::operation::get_catalogs::GetCatalogsInput).
pub fn build(self) -> ::std::result::Result<crate::operation::get_catalogs::GetCatalogsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_catalogs::GetCatalogsInput {
parent_catalog_id: self.parent_catalog_id,
next_token: self.next_token,
max_results: self.max_results,
recursive: self.recursive,
include_root: self.include_root,
has_databases: self.has_databases,
})
}
}