#[non_exhaustive]pub struct DescribeStatementOutputBuilder { /* private fields */ }Expand description
A builder for DescribeStatementOutput.
Implementations§
Source§impl DescribeStatementOutputBuilder
impl DescribeStatementOutputBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
This field is required.Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Sourcepub fn get_id(&self) -> &Option<String>
pub fn get_id(&self) -> &Option<String>
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Sourcepub fn secret_arn(self, input: impl Into<String>) -> Self
pub fn secret_arn(self, input: impl Into<String>) -> Self
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
Sourcepub fn set_secret_arn(self, input: Option<String>) -> Self
pub fn set_secret_arn(self, input: Option<String>) -> Self
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
Sourcepub fn get_secret_arn(&self) -> &Option<String>
pub fn get_secret_arn(&self) -> &Option<String>
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
Sourcepub fn set_db_user(self, input: Option<String>) -> Self
pub fn set_db_user(self, input: Option<String>) -> Self
The database user name.
Sourcepub fn get_db_user(&self) -> &Option<String>
pub fn get_db_user(&self) -> &Option<String>
The database user name.
Sourcepub fn set_database(self, input: Option<String>) -> Self
pub fn set_database(self, input: Option<String>) -> Self
The name of the database.
Sourcepub fn get_database(&self) -> &Option<String>
pub fn get_database(&self) -> &Option<String>
The name of the database.
Sourcepub fn cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
The cluster identifier.
Sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
The cluster identifier.
Sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
The cluster identifier.
Sourcepub fn duration(self, input: i64) -> Self
pub fn duration(self, input: i64) -> Self
The amount of time in nanoseconds that the statement ran.
Sourcepub fn set_duration(self, input: Option<i64>) -> Self
pub fn set_duration(self, input: Option<i64>) -> Self
The amount of time in nanoseconds that the statement ran.
Sourcepub fn get_duration(&self) -> &Option<i64>
pub fn get_duration(&self) -> &Option<i64>
The amount of time in nanoseconds that the statement ran.
Sourcepub fn error(self, input: impl Into<String>) -> Self
pub fn error(self, input: impl Into<String>) -> Self
The error message from the cluster if the SQL statement encountered an error while running.
Sourcepub fn set_error(self, input: Option<String>) -> Self
pub fn set_error(self, input: Option<String>) -> Self
The error message from the cluster if the SQL statement encountered an error while running.
Sourcepub fn get_error(&self) -> &Option<String>
pub fn get_error(&self) -> &Option<String>
The error message from the cluster if the SQL statement encountered an error while running.
Sourcepub fn status(self, input: StatusString) -> Self
pub fn status(self, input: StatusString) -> Self
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.
Sourcepub fn set_status(self, input: Option<StatusString>) -> Self
pub fn set_status(self, input: Option<StatusString>) -> Self
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.
Sourcepub fn get_status(&self) -> &Option<StatusString>
pub fn get_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.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time (UTC) when the SQL statement was submitted to run.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time (UTC) when the SQL statement was submitted to run.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time (UTC) when the SQL statement was submitted to run.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_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.
Sourcepub fn redshift_pid(self, input: i64) -> Self
pub fn redshift_pid(self, input: i64) -> Self
The process identifier from Amazon Redshift.
Sourcepub fn set_redshift_pid(self, input: Option<i64>) -> Self
pub fn set_redshift_pid(self, input: Option<i64>) -> Self
The process identifier from Amazon Redshift.
Sourcepub fn get_redshift_pid(&self) -> &Option<i64>
pub fn get_redshift_pid(&self) -> &Option<i64>
The process identifier from Amazon Redshift.
Sourcepub fn has_result_set(self, input: bool) -> Self
pub fn has_result_set(self, input: bool) -> Self
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.
Sourcepub fn set_has_result_set(self, input: Option<bool>) -> Self
pub fn set_has_result_set(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_has_result_set(&self) -> &Option<bool>
pub fn get_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.
Sourcepub fn query_string(self, input: impl Into<String>) -> Self
pub fn query_string(self, input: impl Into<String>) -> Self
The SQL statement text.
Sourcepub fn set_query_string(self, input: Option<String>) -> Self
pub fn set_query_string(self, input: Option<String>) -> Self
The SQL statement text.
Sourcepub fn get_query_string(&self) -> &Option<String>
pub fn get_query_string(&self) -> &Option<String>
The SQL statement text.
Sourcepub fn result_rows(self, input: i64) -> Self
pub fn result_rows(self, input: i64) -> Self
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.
Sourcepub fn set_result_rows(self, input: Option<i64>) -> Self
pub fn set_result_rows(self, input: Option<i64>) -> Self
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.
Sourcepub fn get_result_rows(&self) -> &Option<i64>
pub fn get_result_rows(&self) -> &Option<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.
Sourcepub fn result_size(self, input: i64) -> Self
pub fn result_size(self, input: i64) -> Self
The size in bytes of the returned results. A -1 indicates the value is null.
Sourcepub fn set_result_size(self, input: Option<i64>) -> Self
pub fn set_result_size(self, input: Option<i64>) -> Self
The size in bytes of the returned results. A -1 indicates the value is null.
Sourcepub fn get_result_size(&self) -> &Option<i64>
pub fn get_result_size(&self) -> &Option<i64>
The size in bytes of the returned results. A -1 indicates the value is null.
Sourcepub fn redshift_query_id(self, input: i64) -> Self
pub fn redshift_query_id(self, input: i64) -> Self
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
Sourcepub fn set_redshift_query_id(self, input: Option<i64>) -> Self
pub fn set_redshift_query_id(self, input: Option<i64>) -> Self
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
Sourcepub fn get_redshift_query_id(&self) -> &Option<i64>
pub fn get_redshift_query_id(&self) -> &Option<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.
Sourcepub fn query_parameters(self, input: SqlParameter) -> Self
pub fn query_parameters(self, input: SqlParameter) -> Self
Appends an item to query_parameters.
To override the contents of this collection use set_query_parameters.
The parameters for the SQL statement.
Sourcepub fn set_query_parameters(self, input: Option<Vec<SqlParameter>>) -> Self
pub fn set_query_parameters(self, input: Option<Vec<SqlParameter>>) -> Self
The parameters for the SQL statement.
Sourcepub fn get_query_parameters(&self) -> &Option<Vec<SqlParameter>>
pub fn get_query_parameters(&self) -> &Option<Vec<SqlParameter>>
The parameters for the SQL statement.
Sourcepub fn sub_statements(self, input: SubStatementData) -> Self
pub fn sub_statements(self, input: SubStatementData) -> Self
Appends an item to sub_statements.
To override the contents of this collection use set_sub_statements.
The SQL statements from a multiple statement run.
Sourcepub fn set_sub_statements(self, input: Option<Vec<SubStatementData>>) -> Self
pub fn set_sub_statements(self, input: Option<Vec<SubStatementData>>) -> Self
The SQL statements from a multiple statement run.
Sourcepub fn get_sub_statements(&self) -> &Option<Vec<SubStatementData>>
pub fn get_sub_statements(&self) -> &Option<Vec<SubStatementData>>
The SQL statements from a multiple statement run.
Sourcepub fn workgroup_name(self, input: impl Into<String>) -> Self
pub fn workgroup_name(self, input: impl Into<String>) -> Self
The serverless workgroup name or Amazon Resource Name (ARN).
Sourcepub fn set_workgroup_name(self, input: Option<String>) -> Self
pub fn set_workgroup_name(self, input: Option<String>) -> Self
The serverless workgroup name or Amazon Resource Name (ARN).
Sourcepub fn get_workgroup_name(&self) -> &Option<String>
pub fn get_workgroup_name(&self) -> &Option<String>
The serverless workgroup name or Amazon Resource Name (ARN).
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The session identifier of the query.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The session identifier of the query.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The session identifier of the query.
Sourcepub fn result_format(self, input: ResultFormatString) -> Self
pub fn result_format(self, input: ResultFormatString) -> Self
The data format of the result of the SQL statement.
Sourcepub fn set_result_format(self, input: Option<ResultFormatString>) -> Self
pub fn set_result_format(self, input: Option<ResultFormatString>) -> Self
The data format of the result of the SQL statement.
Sourcepub fn get_result_format(&self) -> &Option<ResultFormatString>
pub fn get_result_format(&self) -> &Option<ResultFormatString>
The data format of the result of the SQL statement.
Sourcepub fn build(self) -> Result<DescribeStatementOutput, BuildError>
pub fn build(self) -> Result<DescribeStatementOutput, BuildError>
Consumes the builder and constructs a DescribeStatementOutput.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for DescribeStatementOutputBuilder
impl Clone for DescribeStatementOutputBuilder
Source§fn clone(&self) -> DescribeStatementOutputBuilder
fn clone(&self) -> DescribeStatementOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for DescribeStatementOutputBuilder
impl Default for DescribeStatementOutputBuilder
Source§fn default() -> DescribeStatementOutputBuilder
fn default() -> DescribeStatementOutputBuilder
Source§impl PartialEq for DescribeStatementOutputBuilder
impl PartialEq for DescribeStatementOutputBuilder
Source§fn eq(&self, other: &DescribeStatementOutputBuilder) -> bool
fn eq(&self, other: &DescribeStatementOutputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DescribeStatementOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeStatementOutputBuilder
impl RefUnwindSafe for DescribeStatementOutputBuilder
impl Send for DescribeStatementOutputBuilder
impl Sync for DescribeStatementOutputBuilder
impl Unpin for DescribeStatementOutputBuilder
impl UnwindSafe for DescribeStatementOutputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);