Struct aws_sdk_redshiftdata::operation::describe_statement::DescribeStatementOutput

#[non_exhaustive]
pub struct DescribeStatementOutput {

    pub id: String,
    pub secret_arn: Option<String>,
    pub db_user: Option<String>,
    pub database: Option<String>,
    pub cluster_identifier: Option<String>,
    pub duration: i64,
    pub error: Option<String>,
    pub status: Option<StatusString>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub redshift_pid: i64,
    pub has_result_set: Option<bool>,
    pub query_string: Option<String>,
    pub result_rows: i64,
    pub result_size: i64,
    pub redshift_query_id: i64,
    pub query_parameters: Option<Vec<SqlParameter>>,
    pub sub_statements: Option<Vec<SubStatementData>>,
    pub workgroup_name: Option<String>,
    /* private fields */
}

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.

id: String

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

secret_arn: Option<String>

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

db_user: Option<String>

The database user name.

database: Option<String>

The name of the database.

cluster_identifier: Option<String>

The cluster identifier.

duration: i64

The amount of time in nanoseconds that the statement ran.

error: Option<String>

The error message from the cluster if the SQL statement encountered an error while running.

status: Option<StatusString>

The status of the SQL statement being described. Status values are defined as follows:

• ABORTED - The query run was stopped by the user.

• ALL - A status value that includes all query statuses. This value can be used to filter results.

• FAILED - The query run failed.

• FINISHED - The query has finished running.

• PICKED - The query has been chosen to be run.

• STARTED - The query run has started.

• SUBMITTED - The query was submitted, but not yet processed.

created_at: Option<DateTime>

The date and time (UTC) when the SQL statement was submitted to run.

updated_at: Option<DateTime>

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

redshift_pid: i64

The process identifier from Amazon Redshift.

has_result_set: Option<bool>

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

query_string: Option<String>

The SQL statement text.

result_rows: i64

Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

result_size: i64

The size in bytes of the returned results. A -1 indicates the value is null.

redshift_query_id: i64

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

query_parameters: Option<Vec<SqlParameter>>

The parameters for the SQL statement.

sub_statements: Option<Vec<SubStatementData>>

The SQL statements from a multiple statement run.

workgroup_name: Option<String>

The serverless workgroup name or Amazon Resource Name (ARN).

Implementations

impl DescribeStatementOutput

pub fn id(&self) -> &str

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

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

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

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

The database user name.

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

The name of the database.

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

The cluster identifier.

pub fn duration(&self) -> i64

The amount of time in nanoseconds that the statement ran.

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

The error message from the cluster if the SQL statement encountered an error while running.

pub fn status(&self) -> Option<&StatusString>

The status of the SQL statement being described. Status values are defined as follows:

• ABORTED - The query run was stopped by the user.

• ALL - A status value that includes all query statuses. This value can be used to filter results.

• FAILED - The query run failed.

• FINISHED - The query has finished running.

• PICKED - The query has been chosen to be run.

• STARTED - The query run has started.

• SUBMITTED - The query was submitted, but not yet processed.

pub fn created_at(&self) -> Option<&DateTime>

The date and time (UTC) when the SQL statement was submitted to run.

pub fn updated_at(&self) -> Option<&DateTime>

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

pub fn redshift_pid(&self) -> i64

The process identifier from Amazon Redshift.

pub fn has_result_set(&self) -> Option<bool>

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

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

The SQL statement text.

pub fn result_rows(&self) -> i64

Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

pub fn result_size(&self) -> i64

The size in bytes of the returned results. A -1 indicates the value is null.

pub fn redshift_query_id(&self) -> i64

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

pub fn query_parameters(&self) -> &[SqlParameter]

The parameters for the SQL statement.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .query_parameters.is_none().

pub fn sub_statements(&self) -> &[SubStatementData]

The SQL statements from a multiple statement run.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sub_statements.is_none().

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

The serverless workgroup name or Amazon Resource Name (ARN).

impl DescribeStatementOutput

pub fn builder() -> DescribeStatementOutputBuilder

Creates a new builder-style object to manufacture DescribeStatementOutput.

Trait Implementations

impl Clone for DescribeStatementOutput

fn clone(&self) -> DescribeStatementOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeStatementOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeStatementOutput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeStatementOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeStatementOutput