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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
// 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 GetTablesInput {
/// <p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p>
pub catalog_id: ::std::option::Option<::std::string::String>,
/// <p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p>
pub database_name: ::std::option::Option<::std::string::String>,
/// <p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p>
pub expression: ::std::option::Option<::std::string::String>,
/// <p>A continuation token, included if this is a continuation call.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of tables to return in a single response.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The transaction ID at which to read the table contents.</p>
pub transaction_id: ::std::option::Option<::std::string::String>,
/// <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
pub query_as_of_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>
pub audit_context: ::std::option::Option<crate::types::AuditContext>,
/// <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>
pub include_status_details: ::std::option::Option<bool>,
/// <p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p>
/// <p>The following are the valid combinations of values:</p>
/// <ul>
/// <li>
/// <p><code>NAME</code> - Names of all tables in the database.</p></li>
/// <li>
/// <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li>
/// </ul>
pub attributes_to_get: ::std::option::Option<::std::vec::Vec<crate::types::TableAttributes>>,
}
impl GetTablesInput {
/// <p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p>
pub fn catalog_id(&self) -> ::std::option::Option<&str> {
self.catalog_id.as_deref()
}
/// <p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p>
pub fn database_name(&self) -> ::std::option::Option<&str> {
self.database_name.as_deref()
}
/// <p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p>
pub fn expression(&self) -> ::std::option::Option<&str> {
self.expression.as_deref()
}
/// <p>A continuation token, included 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 tables to return in a single response.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The transaction ID at which to read the table contents.</p>
pub fn transaction_id(&self) -> ::std::option::Option<&str> {
self.transaction_id.as_deref()
}
/// <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
pub fn query_as_of_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.query_as_of_time.as_ref()
}
/// <p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>
pub fn audit_context(&self) -> ::std::option::Option<&crate::types::AuditContext> {
self.audit_context.as_ref()
}
/// <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>
pub fn include_status_details(&self) -> ::std::option::Option<bool> {
self.include_status_details
}
/// <p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p>
/// <p>The following are the valid combinations of values:</p>
/// <ul>
/// <li>
/// <p><code>NAME</code> - Names of all tables in the database.</p></li>
/// <li>
/// <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.attributes_to_get.is_none()`.
pub fn attributes_to_get(&self) -> &[crate::types::TableAttributes] {
self.attributes_to_get.as_deref().unwrap_or_default()
}
}
impl GetTablesInput {
/// Creates a new builder-style object to manufacture [`GetTablesInput`](crate::operation::get_tables::GetTablesInput).
pub fn builder() -> crate::operation::get_tables::builders::GetTablesInputBuilder {
crate::operation::get_tables::builders::GetTablesInputBuilder::default()
}
}
/// A builder for [`GetTablesInput`](crate::operation::get_tables::GetTablesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetTablesInputBuilder {
pub(crate) catalog_id: ::std::option::Option<::std::string::String>,
pub(crate) database_name: ::std::option::Option<::std::string::String>,
pub(crate) expression: ::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) transaction_id: ::std::option::Option<::std::string::String>,
pub(crate) query_as_of_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) audit_context: ::std::option::Option<crate::types::AuditContext>,
pub(crate) include_status_details: ::std::option::Option<bool>,
pub(crate) attributes_to_get: ::std::option::Option<::std::vec::Vec<crate::types::TableAttributes>>,
}
impl GetTablesInputBuilder {
/// <p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p>
pub fn catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.catalog_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p>
pub fn set_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.catalog_id = input;
self
}
/// <p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p>
pub fn get_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
&self.catalog_id
}
/// <p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p>
/// This field is required.
pub fn database_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.database_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p>
pub fn set_database_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.database_name = input;
self
}
/// <p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p>
pub fn get_database_name(&self) -> &::std::option::Option<::std::string::String> {
&self.database_name
}
/// <p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p>
pub fn expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.expression = ::std::option::Option::Some(input.into());
self
}
/// <p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p>
pub fn set_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.expression = input;
self
}
/// <p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p>
pub fn get_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.expression
}
/// <p>A continuation token, included 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, included 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, included 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 tables to return in a single 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 tables to return in a single 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 tables to return in a single response.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The transaction ID at which to read the table contents.</p>
pub fn transaction_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.transaction_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The transaction ID at which to read the table contents.</p>
pub fn set_transaction_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.transaction_id = input;
self
}
/// <p>The transaction ID at which to read the table contents.</p>
pub fn get_transaction_id(&self) -> &::std::option::Option<::std::string::String> {
&self.transaction_id
}
/// <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
pub fn query_as_of_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.query_as_of_time = ::std::option::Option::Some(input);
self
}
/// <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
pub fn set_query_as_of_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.query_as_of_time = input;
self
}
/// <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
pub fn get_query_as_of_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.query_as_of_time
}
/// <p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>
pub fn audit_context(mut self, input: crate::types::AuditContext) -> Self {
self.audit_context = ::std::option::Option::Some(input);
self
}
/// <p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>
pub fn set_audit_context(mut self, input: ::std::option::Option<crate::types::AuditContext>) -> Self {
self.audit_context = input;
self
}
/// <p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>
pub fn get_audit_context(&self) -> &::std::option::Option<crate::types::AuditContext> {
&self.audit_context
}
/// <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>
pub fn include_status_details(mut self, input: bool) -> Self {
self.include_status_details = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>
pub fn set_include_status_details(mut self, input: ::std::option::Option<bool>) -> Self {
self.include_status_details = input;
self
}
/// <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>
pub fn get_include_status_details(&self) -> &::std::option::Option<bool> {
&self.include_status_details
}
/// Appends an item to `attributes_to_get`.
///
/// To override the contents of this collection use [`set_attributes_to_get`](Self::set_attributes_to_get).
///
/// <p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p>
/// <p>The following are the valid combinations of values:</p>
/// <ul>
/// <li>
/// <p><code>NAME</code> - Names of all tables in the database.</p></li>
/// <li>
/// <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li>
/// </ul>
pub fn attributes_to_get(mut self, input: crate::types::TableAttributes) -> Self {
let mut v = self.attributes_to_get.unwrap_or_default();
v.push(input);
self.attributes_to_get = ::std::option::Option::Some(v);
self
}
/// <p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p>
/// <p>The following are the valid combinations of values:</p>
/// <ul>
/// <li>
/// <p><code>NAME</code> - Names of all tables in the database.</p></li>
/// <li>
/// <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li>
/// </ul>
pub fn set_attributes_to_get(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TableAttributes>>) -> Self {
self.attributes_to_get = input;
self
}
/// <p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p>
/// <p>The following are the valid combinations of values:</p>
/// <ul>
/// <li>
/// <p><code>NAME</code> - Names of all tables in the database.</p></li>
/// <li>
/// <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li>
/// </ul>
pub fn get_attributes_to_get(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TableAttributes>> {
&self.attributes_to_get
}
/// Consumes the builder and constructs a [`GetTablesInput`](crate::operation::get_tables::GetTablesInput).
pub fn build(self) -> ::std::result::Result<crate::operation::get_tables::GetTablesInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_tables::GetTablesInput {
catalog_id: self.catalog_id,
database_name: self.database_name,
expression: self.expression,
next_token: self.next_token,
max_results: self.max_results,
transaction_id: self.transaction_id,
query_as_of_time: self.query_as_of_time,
audit_context: self.audit_context,
include_status_details: self.include_status_details,
attributes_to_get: self.attributes_to_get,
})
}
}