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
// 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 DescribeTableInput {
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub cluster_identifier: ::std::option::Option<::std::string::String>,
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub secret_arn: ::std::option::Option<::std::string::String>,
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub db_user: ::std::option::Option<::std::string::String>,
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub database: ::std::option::Option<::std::string::String>,
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub connected_database: ::std::option::Option<::std::string::String>,
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub schema: ::std::option::Option<::std::string::String>,
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub table: ::std::option::Option<::std::string::String>,
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub max_results: ::std::option::Option<i32>,
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub workgroup_name: ::std::option::Option<::std::string::String>,
}
impl DescribeTableInput {
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(&self) -> ::std::option::Option<&str> {
self.cluster_identifier.as_deref()
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(&self) -> ::std::option::Option<&str> {
self.secret_arn.as_deref()
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn db_user(&self) -> ::std::option::Option<&str> {
self.db_user.as_deref()
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn database(&self) -> ::std::option::Option<&str> {
self.database.as_deref()
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn connected_database(&self) -> ::std::option::Option<&str> {
self.connected_database.as_deref()
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn schema(&self) -> ::std::option::Option<&str> {
self.schema.as_deref()
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn table(&self) -> ::std::option::Option<&str> {
self.table.as_deref()
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn workgroup_name(&self) -> ::std::option::Option<&str> {
self.workgroup_name.as_deref()
}
}
impl DescribeTableInput {
/// Creates a new builder-style object to manufacture [`DescribeTableInput`](crate::operation::describe_table::DescribeTableInput).
pub fn builder() -> crate::operation::describe_table::builders::DescribeTableInputBuilder {
crate::operation::describe_table::builders::DescribeTableInputBuilder::default()
}
}
/// A builder for [`DescribeTableInput`](crate::operation::describe_table::DescribeTableInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeTableInputBuilder {
pub(crate) cluster_identifier: ::std::option::Option<::std::string::String>,
pub(crate) secret_arn: ::std::option::Option<::std::string::String>,
pub(crate) db_user: ::std::option::Option<::std::string::String>,
pub(crate) database: ::std::option::Option<::std::string::String>,
pub(crate) connected_database: ::std::option::Option<::std::string::String>,
pub(crate) schema: ::std::option::Option<::std::string::String>,
pub(crate) table: ::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) workgroup_name: ::std::option::Option<::std::string::String>,
}
impl DescribeTableInputBuilder {
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.cluster_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.cluster_identifier = input;
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn get_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.cluster_identifier
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.secret_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.secret_arn = input;
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn get_secret_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.secret_arn
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.db_user = ::std::option::Option::Some(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.db_user = input;
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn get_db_user(&self) -> &::std::option::Option<::std::string::String> {
&self.db_user
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
/// This field is required.
pub fn database(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.database = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn set_database(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.database = input;
self
}
/// <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
pub fn get_database(&self) -> &::std::option::Option<::std::string::String> {
&self.database
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn connected_database(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.connected_database = ::std::option::Option::Some(input.into());
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn set_connected_database(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.connected_database = input;
self
}
/// <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
pub fn get_connected_database(&self) -> &::std::option::Option<::std::string::String> {
&self.connected_database
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn schema(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.schema = ::std::option::Option::Some(input.into());
self
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn set_schema(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.schema = input;
self
}
/// <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
pub fn get_schema(&self) -> &::std::option::Option<::std::string::String> {
&self.schema
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn table(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.table = ::std::option::Option::Some(input.into());
self
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn set_table(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.table = input;
self
}
/// <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
pub fn get_table(&self) -> &::std::option::Option<::std::string::String> {
&self.table
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </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 value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </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 the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </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 the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </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 the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn workgroup_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.workgroup_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn set_workgroup_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.workgroup_name = input;
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn get_workgroup_name(&self) -> &::std::option::Option<::std::string::String> {
&self.workgroup_name
}
/// Consumes the builder and constructs a [`DescribeTableInput`](crate::operation::describe_table::DescribeTableInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_table::DescribeTableInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_table::DescribeTableInput {
cluster_identifier: self.cluster_identifier,
secret_arn: self.secret_arn,
db_user: self.db_user,
database: self.database,
connected_database: self.connected_database,
schema: self.schema,
table: self.table,
next_token: self.next_token,
max_results: self.max_results,
workgroup_name: self.workgroup_name,
})
}
}