#[non_exhaustive]pub struct StepConfig {
pub name: Option<String>,
pub action_on_failure: Option<ActionOnFailure>,
pub hadoop_jar_step: Option<HadoopJarStepConfig>,
}
Expand description
Specification for a cluster (job flow) step.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of the step.
action_on_failure: Option<ActionOnFailure>
The action to take when the step fails. Use one of the following values:
-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
hadoop_jar_step: Option<HadoopJarStepConfig>
The JAR file used for the step.
Implementations§
Source§impl StepConfig
impl StepConfig
Sourcepub fn action_on_failure(&self) -> Option<&ActionOnFailure>
pub fn action_on_failure(&self) -> Option<&ActionOnFailure>
The action to take when the step fails. Use one of the following values:
-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
Sourcepub fn hadoop_jar_step(&self) -> Option<&HadoopJarStepConfig>
pub fn hadoop_jar_step(&self) -> Option<&HadoopJarStepConfig>
The JAR file used for the step.
Source§impl StepConfig
impl StepConfig
Sourcepub fn builder() -> StepConfigBuilder
pub fn builder() -> StepConfigBuilder
Creates a new builder-style object to manufacture StepConfig
.
Trait Implementations§
Source§impl Clone for StepConfig
impl Clone for StepConfig
Source§fn clone(&self) -> StepConfig
fn clone(&self) -> StepConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StepConfig
impl Debug for StepConfig
Source§impl PartialEq for StepConfig
impl PartialEq for StepConfig
impl StructuralPartialEq for StepConfig
Auto Trait Implementations§
impl Freeze for StepConfig
impl RefUnwindSafe for StepConfig
impl Send for StepConfig
impl Sync for StepConfig
impl Unpin for StepConfig
impl UnwindSafe for StepConfig
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);