#[non_exhaustive]pub struct NotebookExecutionSummaryBuilder { /* private fields */ }Expand description
A builder for NotebookExecutionSummary.
Implementations§
source§impl NotebookExecutionSummaryBuilder
impl NotebookExecutionSummaryBuilder
sourcepub fn notebook_execution_id(self, input: impl Into<String>) -> Self
pub fn notebook_execution_id(self, input: impl Into<String>) -> Self
The unique identifier of the notebook execution.
sourcepub fn set_notebook_execution_id(self, input: Option<String>) -> Self
pub fn set_notebook_execution_id(self, input: Option<String>) -> Self
The unique identifier of the notebook execution.
sourcepub fn get_notebook_execution_id(&self) -> &Option<String>
pub fn get_notebook_execution_id(&self) -> &Option<String>
The unique identifier of the notebook execution.
sourcepub fn editor_id(self, input: impl Into<String>) -> Self
pub fn editor_id(self, input: impl Into<String>) -> Self
The unique identifier of the editor associated with the notebook execution.
sourcepub fn set_editor_id(self, input: Option<String>) -> Self
pub fn set_editor_id(self, input: Option<String>) -> Self
The unique identifier of the editor associated with the notebook execution.
sourcepub fn get_editor_id(&self) -> &Option<String>
pub fn get_editor_id(&self) -> &Option<String>
The unique identifier of the editor associated with the notebook execution.
sourcepub fn notebook_execution_name(self, input: impl Into<String>) -> Self
pub fn notebook_execution_name(self, input: impl Into<String>) -> Self
The name of the notebook execution.
sourcepub fn set_notebook_execution_name(self, input: Option<String>) -> Self
pub fn set_notebook_execution_name(self, input: Option<String>) -> Self
The name of the notebook execution.
sourcepub fn get_notebook_execution_name(&self) -> &Option<String>
pub fn get_notebook_execution_name(&self) -> &Option<String>
The name of the notebook execution.
sourcepub fn status(self, input: NotebookExecutionStatus) -> Self
pub fn status(self, input: NotebookExecutionStatus) -> Self
The status of the notebook execution.
-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
sourcepub fn set_status(self, input: Option<NotebookExecutionStatus>) -> Self
pub fn set_status(self, input: Option<NotebookExecutionStatus>) -> Self
The status of the notebook execution.
-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
sourcepub fn get_status(&self) -> &Option<NotebookExecutionStatus>
pub fn get_status(&self) -> &Option<NotebookExecutionStatus>
The status of the notebook execution.
-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The timestamp when notebook execution started.
sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The timestamp when notebook execution started.
sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The timestamp when notebook execution started.
sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The timestamp when notebook execution started.
sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The timestamp when notebook execution started.
sourcepub fn notebook_s3_location(self, input: NotebookS3LocationForOutput) -> Self
pub fn notebook_s3_location(self, input: NotebookS3LocationForOutput) -> Self
The Amazon S3 location that stores the notebook execution input.
sourcepub fn set_notebook_s3_location(
self,
input: Option<NotebookS3LocationForOutput>,
) -> Self
pub fn set_notebook_s3_location( self, input: Option<NotebookS3LocationForOutput>, ) -> Self
The Amazon S3 location that stores the notebook execution input.
sourcepub fn get_notebook_s3_location(&self) -> &Option<NotebookS3LocationForOutput>
pub fn get_notebook_s3_location(&self) -> &Option<NotebookS3LocationForOutput>
The Amazon S3 location that stores the notebook execution input.
sourcepub fn execution_engine_id(self, input: impl Into<String>) -> Self
pub fn execution_engine_id(self, input: impl Into<String>) -> Self
The unique ID of the execution engine for the notebook execution.
sourcepub fn set_execution_engine_id(self, input: Option<String>) -> Self
pub fn set_execution_engine_id(self, input: Option<String>) -> Self
The unique ID of the execution engine for the notebook execution.
sourcepub fn get_execution_engine_id(&self) -> &Option<String>
pub fn get_execution_engine_id(&self) -> &Option<String>
The unique ID of the execution engine for the notebook execution.
sourcepub fn build(self) -> NotebookExecutionSummary
pub fn build(self) -> NotebookExecutionSummary
Consumes the builder and constructs a NotebookExecutionSummary.
Trait Implementations§
source§impl Clone for NotebookExecutionSummaryBuilder
impl Clone for NotebookExecutionSummaryBuilder
source§fn clone(&self) -> NotebookExecutionSummaryBuilder
fn clone(&self) -> NotebookExecutionSummaryBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Default for NotebookExecutionSummaryBuilder
impl Default for NotebookExecutionSummaryBuilder
source§fn default() -> NotebookExecutionSummaryBuilder
fn default() -> NotebookExecutionSummaryBuilder
source§impl PartialEq for NotebookExecutionSummaryBuilder
impl PartialEq for NotebookExecutionSummaryBuilder
source§fn eq(&self, other: &NotebookExecutionSummaryBuilder) -> bool
fn eq(&self, other: &NotebookExecutionSummaryBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for NotebookExecutionSummaryBuilder
Auto Trait Implementations§
impl Freeze for NotebookExecutionSummaryBuilder
impl RefUnwindSafe for NotebookExecutionSummaryBuilder
impl Send for NotebookExecutionSummaryBuilder
impl Sync for NotebookExecutionSummaryBuilder
impl Unpin for NotebookExecutionSummaryBuilder
impl UnwindSafe for NotebookExecutionSummaryBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());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>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());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>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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);