#[non_exhaustive]pub struct NotebookExecutionBuilder { /* private fields */ }
Expand description
A builder for NotebookExecution
.
Implementations§
Source§impl NotebookExecutionBuilder
impl NotebookExecutionBuilder
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 a 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 a notebook execution.
Sourcepub fn get_notebook_execution_id(&self) -> &Option<String>
pub fn get_notebook_execution_id(&self) -> &Option<String>
The unique identifier of a 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 Amazon EMR Notebook that is used for 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 Amazon EMR Notebook that is used for the notebook execution.
Sourcepub fn get_editor_id(&self) -> &Option<String>
pub fn get_editor_id(&self) -> &Option<String>
The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
Sourcepub fn execution_engine(self, input: ExecutionEngineConfig) -> Self
pub fn execution_engine(self, input: ExecutionEngineConfig) -> Self
The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
Sourcepub fn set_execution_engine(self, input: Option<ExecutionEngineConfig>) -> Self
pub fn set_execution_engine(self, input: Option<ExecutionEngineConfig>) -> Self
The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
Sourcepub fn get_execution_engine(&self) -> &Option<ExecutionEngineConfig>
pub fn get_execution_engine(&self) -> &Option<ExecutionEngineConfig>
The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform 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
A name for 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
A name for the notebook execution.
Sourcepub fn get_notebook_execution_name(&self) -> &Option<String>
pub fn get_notebook_execution_name(&self) -> &Option<String>
A name for the notebook execution.
Sourcepub fn notebook_params(self, input: impl Into<String>) -> Self
pub fn notebook_params(self, input: impl Into<String>) -> Self
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn set_notebook_params(self, input: Option<String>) -> Self
pub fn set_notebook_params(self, input: Option<String>) -> Self
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn get_notebook_params(&self) -> &Option<String>
pub fn get_notebook_params(&self) -> &Option<String>
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn status(self, input: NotebookExecutionStatus) -> Self
pub fn status(self, input: NotebookExecutionStatus) -> Self
The status of the notebook execution.
-
START_PENDING
indicates that the cluster has received the execution request but execution has not begun. -
STARTING
indicates that the execution is starting on the cluster. -
RUNNING
indicates that the execution is being processed by the cluster. -
FINISHING
indicates that execution processing is in the final stages. -
FINISHED
indicates that the execution has completed without error. -
FAILING
indicates that the execution is failing and will not finish successfully. -
FAILED
indicates that the execution failed. -
STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
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_PENDING
indicates that the cluster has received the execution request but execution has not begun. -
STARTING
indicates that the execution is starting on the cluster. -
RUNNING
indicates that the execution is being processed by the cluster. -
FINISHING
indicates that execution processing is in the final stages. -
FINISHED
indicates that the execution has completed without error. -
FAILING
indicates that the execution is failing and will not finish successfully. -
FAILED
indicates that the execution failed. -
STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
Sourcepub fn get_status(&self) -> &Option<NotebookExecutionStatus>
pub fn get_status(&self) -> &Option<NotebookExecutionStatus>
The status of the notebook execution.
-
START_PENDING
indicates that the cluster has received the execution request but execution has not begun. -
STARTING
indicates that the execution is starting on the cluster. -
RUNNING
indicates that the execution is being processed by the cluster. -
FINISHING
indicates that execution processing is in the final stages. -
FINISHED
indicates that the execution has completed without error. -
FAILING
indicates that the execution is failing and will not finish successfully. -
FAILED
indicates that the execution failed. -
STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
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 ended.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The timestamp when notebook execution ended.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the notebook execution.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the notebook execution.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the notebook execution.
Sourcepub fn output_notebook_uri(self, input: impl Into<String>) -> Self
pub fn output_notebook_uri(self, input: impl Into<String>) -> Self
The location of the notebook execution's output file in Amazon S3.
Sourcepub fn set_output_notebook_uri(self, input: Option<String>) -> Self
pub fn set_output_notebook_uri(self, input: Option<String>) -> Self
The location of the notebook execution's output file in Amazon S3.
Sourcepub fn get_output_notebook_uri(&self) -> &Option<String>
pub fn get_output_notebook_uri(&self) -> &Option<String>
The location of the notebook execution's output file in Amazon S3.
Sourcepub fn last_state_change_reason(self, input: impl Into<String>) -> Self
pub fn last_state_change_reason(self, input: impl Into<String>) -> Self
The reason for the latest status change of the notebook execution.
Sourcepub fn set_last_state_change_reason(self, input: Option<String>) -> Self
pub fn set_last_state_change_reason(self, input: Option<String>) -> Self
The reason for the latest status change of the notebook execution.
Sourcepub fn get_last_state_change_reason(&self) -> &Option<String>
pub fn get_last_state_change_reason(&self) -> &Option<String>
The reason for the latest status change of the notebook execution.
Sourcepub fn notebook_instance_security_group_id(
self,
input: impl Into<String>,
) -> Self
pub fn notebook_instance_security_group_id( self, input: impl Into<String>, ) -> Self
The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
Sourcepub fn set_notebook_instance_security_group_id(
self,
input: Option<String>,
) -> Self
pub fn set_notebook_instance_security_group_id( self, input: Option<String>, ) -> Self
The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
Sourcepub fn get_notebook_instance_security_group_id(&self) -> &Option<String>
pub fn get_notebook_instance_security_group_id(&self) -> &Option<String>
The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
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 output_notebook_s3_location(
self,
input: OutputNotebookS3LocationForOutput,
) -> Self
pub fn output_notebook_s3_location( self, input: OutputNotebookS3LocationForOutput, ) -> Self
The Amazon S3 location for the notebook execution output.
Sourcepub fn set_output_notebook_s3_location(
self,
input: Option<OutputNotebookS3LocationForOutput>,
) -> Self
pub fn set_output_notebook_s3_location( self, input: Option<OutputNotebookS3LocationForOutput>, ) -> Self
The Amazon S3 location for the notebook execution output.
Sourcepub fn get_output_notebook_s3_location(
&self,
) -> &Option<OutputNotebookS3LocationForOutput>
pub fn get_output_notebook_s3_location( &self, ) -> &Option<OutputNotebookS3LocationForOutput>
The Amazon S3 location for the notebook execution output.
Sourcepub fn output_notebook_format(self, input: OutputNotebookFormat) -> Self
pub fn output_notebook_format(self, input: OutputNotebookFormat) -> Self
The output format for the notebook execution.
Sourcepub fn set_output_notebook_format(
self,
input: Option<OutputNotebookFormat>,
) -> Self
pub fn set_output_notebook_format( self, input: Option<OutputNotebookFormat>, ) -> Self
The output format for the notebook execution.
Sourcepub fn get_output_notebook_format(&self) -> &Option<OutputNotebookFormat>
pub fn get_output_notebook_format(&self) -> &Option<OutputNotebookFormat>
The output format for the notebook execution.
Sourcepub fn environment_variables(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn environment_variables( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to environment_variables
.
To override the contents of this collection use set_environment_variables
.
The environment variables associated with the notebook execution.
Sourcepub fn set_environment_variables(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_environment_variables( self, input: Option<HashMap<String, String>>, ) -> Self
The environment variables associated with the notebook execution.
Sourcepub fn get_environment_variables(&self) -> &Option<HashMap<String, String>>
pub fn get_environment_variables(&self) -> &Option<HashMap<String, String>>
The environment variables associated with the notebook execution.
Sourcepub fn build(self) -> NotebookExecution
pub fn build(self) -> NotebookExecution
Consumes the builder and constructs a NotebookExecution
.
Trait Implementations§
Source§impl Clone for NotebookExecutionBuilder
impl Clone for NotebookExecutionBuilder
Source§fn clone(&self) -> NotebookExecutionBuilder
fn clone(&self) -> NotebookExecutionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for NotebookExecutionBuilder
impl Debug for NotebookExecutionBuilder
Source§impl Default for NotebookExecutionBuilder
impl Default for NotebookExecutionBuilder
Source§fn default() -> NotebookExecutionBuilder
fn default() -> NotebookExecutionBuilder
Source§impl PartialEq for NotebookExecutionBuilder
impl PartialEq for NotebookExecutionBuilder
impl StructuralPartialEq for NotebookExecutionBuilder
Auto Trait Implementations§
impl Freeze for NotebookExecutionBuilder
impl RefUnwindSafe for NotebookExecutionBuilder
impl Send for NotebookExecutionBuilder
impl Sync for NotebookExecutionBuilder
impl Unpin for NotebookExecutionBuilder
impl UnwindSafe for NotebookExecutionBuilder
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);