#[non_exhaustive]pub struct SessionDataBuilder { /* private fields */ }Expand description
A builder for SessionData.
Implementations§
Source§impl SessionDataBuilder
impl SessionDataBuilder
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
This field is required.Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Sourcepub fn status(self, input: SessionStatusString) -> Self
pub fn status(self, input: SessionStatusString) -> Self
The status of the session. Status values are defined as follows:
-
AVAILABLE – The session is open and ready to run a SQL statement.
-
BUSY – The session is currently running a SQL statement.
-
CLOSED – The session is closed and can no longer run SQL statements.
Sourcepub fn set_status(self, input: Option<SessionStatusString>) -> Self
pub fn set_status(self, input: Option<SessionStatusString>) -> Self
The status of the session. Status values are defined as follows:
-
AVAILABLE – The session is open and ready to run a SQL statement.
-
BUSY – The session is currently running a SQL statement.
-
CLOSED – The session is closed and can no longer run SQL statements.
Sourcepub fn get_status(&self) -> &Option<SessionStatusString>
pub fn get_status(&self) -> &Option<SessionStatusString>
The status of the session. Status values are defined as follows:
-
AVAILABLE – The session is open and ready to run a SQL statement.
-
BUSY – The session is currently running a SQL statement.
-
CLOSED – The session is closed and can no longer run SQL statements.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time (UTC) when the session was created.
This field is required.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 session was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time (UTC) when the session was created.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The date and time (UTC) that the session metadata 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 session metadata 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 session metadata was last updated. An example is the time the status last changed.
Sourcepub fn database(self, input: impl Into<String>) -> Self
pub fn database(self, input: impl Into<String>) -> Self
The name of the database that the session is connected to.
Sourcepub fn set_database(self, input: Option<String>) -> Self
pub fn set_database(self, input: Option<String>) -> Self
The name of the database that the session is connected to.
Sourcepub fn get_database(&self) -> &Option<String>
pub fn get_database(&self) -> &Option<String>
The name of the database that the session is connected to.
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 cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
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). This element is not returned when connecting to a provisioned cluster.
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). This element is not returned when connecting to a provisioned cluster.
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). This element is not returned when connecting to a provisioned cluster.
Sourcepub fn session_alive_seconds(self, input: i32) -> Self
pub fn session_alive_seconds(self, input: i32) -> Self
The number of seconds that the session is kept alive after a query finishes.
Sourcepub fn set_session_alive_seconds(self, input: Option<i32>) -> Self
pub fn set_session_alive_seconds(self, input: Option<i32>) -> Self
The number of seconds that the session is kept alive after a query finishes.
Sourcepub fn get_session_alive_seconds(&self) -> &Option<i32>
pub fn get_session_alive_seconds(&self) -> &Option<i32>
The number of seconds that the session is kept alive after a query finishes.
Sourcepub fn session_ttl(self, input: DateTime) -> Self
pub fn session_ttl(self, input: DateTime) -> Self
The date and time (UTC) when the session is set to expire and be closed.
Sourcepub fn set_session_ttl(self, input: Option<DateTime>) -> Self
pub fn set_session_ttl(self, input: Option<DateTime>) -> Self
The date and time (UTC) when the session is set to expire and be closed.
Sourcepub fn get_session_ttl(&self) -> &Option<DateTime>
pub fn get_session_ttl(&self) -> &Option<DateTime>
The date and time (UTC) when the session is set to expire and be closed.
Sourcepub fn current_statement_id(self, input: impl Into<String>) -> Self
pub fn current_statement_id(self, input: impl Into<String>) -> Self
The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.
Sourcepub fn set_current_statement_id(self, input: Option<String>) -> Self
pub fn set_current_statement_id(self, input: Option<String>) -> Self
The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.
Sourcepub fn get_current_statement_id(&self) -> &Option<String>
pub fn get_current_statement_id(&self) -> &Option<String>
The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.
Sourcepub fn build(self) -> Result<SessionData, BuildError>
pub fn build(self) -> Result<SessionData, BuildError>
Consumes the builder and constructs a SessionData.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for SessionDataBuilder
impl Clone for SessionDataBuilder
Source§fn clone(&self) -> SessionDataBuilder
fn clone(&self) -> SessionDataBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SessionDataBuilder
impl Debug for SessionDataBuilder
Source§impl Default for SessionDataBuilder
impl Default for SessionDataBuilder
Source§fn default() -> SessionDataBuilder
fn default() -> SessionDataBuilder
Source§impl PartialEq for SessionDataBuilder
impl PartialEq for SessionDataBuilder
impl StructuralPartialEq for SessionDataBuilder
Auto Trait Implementations§
impl Freeze for SessionDataBuilder
impl RefUnwindSafe for SessionDataBuilder
impl Send for SessionDataBuilder
impl Sync for SessionDataBuilder
impl Unpin for SessionDataBuilder
impl UnsafeUnpin for SessionDataBuilder
impl UnwindSafe for SessionDataBuilder
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
renamed to 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);