pub struct SendAutomationSignalFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SendAutomationSignal
.
Sends a signal to an Automation execution to change the current behavior or status of the execution.
Implementations§
Source§impl SendAutomationSignalFluentBuilder
impl SendAutomationSignalFluentBuilder
Sourcepub fn as_input(&self) -> &SendAutomationSignalInputBuilder
pub fn as_input(&self) -> &SendAutomationSignalInputBuilder
Access the SendAutomationSignal as a reference.
Sourcepub async fn send(
self,
) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError, HttpResponse>>
pub async fn send( self, ) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SendAutomationSignalOutput, SendAutomationSignalError, Self>
pub fn customize( self, ) -> CustomizableOperation<SendAutomationSignalOutput, SendAutomationSignalError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn automation_execution_id(self, input: impl Into<String>) -> Self
pub fn automation_execution_id(self, input: impl Into<String>) -> Self
The unique identifier for an existing Automation execution that you want to send the signal to.
Sourcepub fn set_automation_execution_id(self, input: Option<String>) -> Self
pub fn set_automation_execution_id(self, input: Option<String>) -> Self
The unique identifier for an existing Automation execution that you want to send the signal to.
Sourcepub fn get_automation_execution_id(&self) -> &Option<String>
pub fn get_automation_execution_id(&self) -> &Option<String>
The unique identifier for an existing Automation execution that you want to send the signal to.
Sourcepub fn signal_type(self, input: SignalType) -> Self
pub fn signal_type(self, input: SignalType) -> Self
The type of signal to send to an Automation execution.
Sourcepub fn set_signal_type(self, input: Option<SignalType>) -> Self
pub fn set_signal_type(self, input: Option<SignalType>) -> Self
The type of signal to send to an Automation execution.
Sourcepub fn get_signal_type(&self) -> &Option<SignalType>
pub fn get_signal_type(&self) -> &Option<SignalType>
The type of signal to send to an Automation execution.
Sourcepub fn payload(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn payload(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to Payload
.
To override the contents of this collection use set_payload
.
The data sent with the signal. The data schema depends on the type of signal used in the request.
For Approve
and Reject
signal types, the payload is an optional comment that you can send with the signal type. For example:
Comment="Looks good"
For StartStep
and Resume
signal types, you must send the name of the Automation step to start or resume as the payload. For example:
StepName="step1"
For the StopStep
signal type, you must send the step execution ID as the payload. For example:
StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
Sourcepub fn set_payload(self, input: Option<HashMap<String, Vec<String>>>) -> Self
pub fn set_payload(self, input: Option<HashMap<String, Vec<String>>>) -> Self
The data sent with the signal. The data schema depends on the type of signal used in the request.
For Approve
and Reject
signal types, the payload is an optional comment that you can send with the signal type. For example:
Comment="Looks good"
For StartStep
and Resume
signal types, you must send the name of the Automation step to start or resume as the payload. For example:
StepName="step1"
For the StopStep
signal type, you must send the step execution ID as the payload. For example:
StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
Sourcepub fn get_payload(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_payload(&self) -> &Option<HashMap<String, Vec<String>>>
The data sent with the signal. The data schema depends on the type of signal used in the request.
For Approve
and Reject
signal types, the payload is an optional comment that you can send with the signal type. For example:
Comment="Looks good"
For StartStep
and Resume
signal types, you must send the name of the Automation step to start or resume as the payload. For example:
StepName="step1"
For the StopStep
signal type, you must send the step execution ID as the payload. For example:
StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
Trait Implementations§
Source§impl Clone for SendAutomationSignalFluentBuilder
impl Clone for SendAutomationSignalFluentBuilder
Source§fn clone(&self) -> SendAutomationSignalFluentBuilder
fn clone(&self) -> SendAutomationSignalFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for SendAutomationSignalFluentBuilder
impl !RefUnwindSafe for SendAutomationSignalFluentBuilder
impl Send for SendAutomationSignalFluentBuilder
impl Sync for SendAutomationSignalFluentBuilder
impl Unpin for SendAutomationSignalFluentBuilder
impl !UnwindSafe for SendAutomationSignalFluentBuilder
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);