Struct aws_sdk_redshiftdata::input::DescribeTableInput

#[non_exhaustive]
pub struct DescribeTableInput {
    pub cluster_identifier: Option<String>,
    pub secret_arn: Option<String>,
    pub db_user: Option<String>,
    pub database: Option<String>,
    pub connected_database: Option<String>,
    pub schema: Option<String>,
    pub table: Option<String>,
    pub next_token: Option<String>,
    pub max_results: i32,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster_identifier: Option<String>

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

secret_arn: Option<String>

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

db_user: Option<String>

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

database: Option<String>

The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

connected_database: Option<String>

A database name. The connected database is specified when you connect with your authentication credentials.

schema: Option<String>

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

table: Option<String>

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

next_token: Option<String>

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.

max_results: i32

The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

Implementations

impl DescribeTableInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeTable, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeTable>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeTableInput

impl DescribeTableInput

pub fn cluster_identifier(&self) -> Option<&str>

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

pub fn secret_arn(&self) -> Option<&str>

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

pub fn db_user(&self) -> Option<&str>

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

pub fn database(&self) -> Option<&str>

The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

pub fn connected_database(&self) -> Option<&str>

A database name. The connected database is specified when you connect with your authentication credentials.

pub fn schema(&self) -> Option<&str>

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

pub fn table(&self) -> Option<&str>

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

pub fn next_token(&self) -> Option<&str>

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.

pub fn max_results(&self) -> i32

The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

Trait Implementations

impl Clone for DescribeTableInput

fn clone(&self) -> DescribeTableInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTableInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DescribeTableInput> for DescribeTableInput

fn eq(&self, other: &DescribeTableInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeTableInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeTableInput