#[non_exhaustive]pub struct StopPipelineExecutionInputBuilder { /* private fields */ }
Expand description
A builder for StopPipelineExecutionInput
.
Implementations§
Source§impl StopPipelineExecutionInputBuilder
impl StopPipelineExecutionInputBuilder
Sourcepub fn pipeline_name(self, input: impl Into<String>) -> Self
pub fn pipeline_name(self, input: impl Into<String>) -> Self
The name of the pipeline to stop.
This field is required.Sourcepub fn set_pipeline_name(self, input: Option<String>) -> Self
pub fn set_pipeline_name(self, input: Option<String>) -> Self
The name of the pipeline to stop.
Sourcepub fn get_pipeline_name(&self) -> &Option<String>
pub fn get_pipeline_name(&self) -> &Option<String>
The name of the pipeline to stop.
Sourcepub fn pipeline_execution_id(self, input: impl Into<String>) -> Self
pub fn pipeline_execution_id(self, input: impl Into<String>) -> Self
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState
action to retrieve the current pipelineExecutionId.
Sourcepub fn set_pipeline_execution_id(self, input: Option<String>) -> Self
pub fn set_pipeline_execution_id(self, input: Option<String>) -> Self
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState
action to retrieve the current pipelineExecutionId.
Sourcepub fn get_pipeline_execution_id(&self) -> &Option<String>
pub fn get_pipeline_execution_id(&self) -> &Option<String>
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState
action to retrieve the current pipelineExecutionId.
Sourcepub fn abandon(self, input: bool) -> Self
pub fn abandon(self, input: bool) -> Self
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
Sourcepub fn set_abandon(self, input: Option<bool>) -> Self
pub fn set_abandon(self, input: Option<bool>) -> Self
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
Sourcepub fn get_abandon(&self) -> &Option<bool>
pub fn get_abandon(&self) -> &Option<bool>
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
Sourcepub fn reason(self, input: impl Into<String>) -> Self
pub fn reason(self, input: impl Into<String>) -> Self
Use this option to enter comments, such as the reason the pipeline was stopped.
Sourcepub fn set_reason(self, input: Option<String>) -> Self
pub fn set_reason(self, input: Option<String>) -> Self
Use this option to enter comments, such as the reason the pipeline was stopped.
Sourcepub fn get_reason(&self) -> &Option<String>
pub fn get_reason(&self) -> &Option<String>
Use this option to enter comments, such as the reason the pipeline was stopped.
Sourcepub fn build(self) -> Result<StopPipelineExecutionInput, BuildError>
pub fn build(self) -> Result<StopPipelineExecutionInput, BuildError>
Consumes the builder and constructs a StopPipelineExecutionInput
.
Source§impl StopPipelineExecutionInputBuilder
impl StopPipelineExecutionInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for StopPipelineExecutionInputBuilder
impl Clone for StopPipelineExecutionInputBuilder
Source§fn clone(&self) -> StopPipelineExecutionInputBuilder
fn clone(&self) -> StopPipelineExecutionInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StopPipelineExecutionInputBuilder
impl Default for StopPipelineExecutionInputBuilder
Source§fn default() -> StopPipelineExecutionInputBuilder
fn default() -> StopPipelineExecutionInputBuilder
Source§impl PartialEq for StopPipelineExecutionInputBuilder
impl PartialEq for StopPipelineExecutionInputBuilder
Source§fn eq(&self, other: &StopPipelineExecutionInputBuilder) -> bool
fn eq(&self, other: &StopPipelineExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StopPipelineExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for StopPipelineExecutionInputBuilder
impl RefUnwindSafe for StopPipelineExecutionInputBuilder
impl Send for StopPipelineExecutionInputBuilder
impl Sync for StopPipelineExecutionInputBuilder
impl Unpin for StopPipelineExecutionInputBuilder
impl UnwindSafe for StopPipelineExecutionInputBuilder
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>
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);