#[non_exhaustive]pub struct TerminateWorkflowExecutionInputBuilder { /* private fields */ }
Expand description
A builder for TerminateWorkflowExecutionInput
.
Implementations§
Source§impl TerminateWorkflowExecutionInputBuilder
impl TerminateWorkflowExecutionInputBuilder
Sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The domain of the workflow execution to terminate.
This field is required.Sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The domain of the workflow execution to terminate.
Sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The domain of the workflow execution to terminate.
Sourcepub fn workflow_id(self, input: impl Into<String>) -> Self
pub fn workflow_id(self, input: impl Into<String>) -> Self
The workflowId of the workflow execution to terminate.
This field is required.Sourcepub fn set_workflow_id(self, input: Option<String>) -> Self
pub fn set_workflow_id(self, input: Option<String>) -> Self
The workflowId of the workflow execution to terminate.
Sourcepub fn get_workflow_id(&self) -> &Option<String>
pub fn get_workflow_id(&self) -> &Option<String>
The workflowId of the workflow execution to terminate.
Sourcepub fn run_id(self, input: impl Into<String>) -> Self
pub fn run_id(self, input: impl Into<String>) -> Self
The runId of the workflow execution to terminate.
Sourcepub fn set_run_id(self, input: Option<String>) -> Self
pub fn set_run_id(self, input: Option<String>) -> Self
The runId of the workflow execution to terminate.
Sourcepub fn get_run_id(&self) -> &Option<String>
pub fn get_run_id(&self) -> &Option<String>
The runId of the workflow execution to terminate.
Sourcepub fn reason(self, input: impl Into<String>) -> Self
pub fn reason(self, input: impl Into<String>) -> Self
A descriptive reason for terminating the workflow execution.
Sourcepub fn set_reason(self, input: Option<String>) -> Self
pub fn set_reason(self, input: Option<String>) -> Self
A descriptive reason for terminating the workflow execution.
Sourcepub fn get_reason(&self) -> &Option<String>
pub fn get_reason(&self) -> &Option<String>
A descriptive reason for terminating the workflow execution.
Sourcepub fn details(self, input: impl Into<String>) -> Self
pub fn details(self, input: impl Into<String>) -> Self
Details for terminating the workflow execution.
Sourcepub fn set_details(self, input: Option<String>) -> Self
pub fn set_details(self, input: Option<String>) -> Self
Details for terminating the workflow execution.
Sourcepub fn get_details(&self) -> &Option<String>
pub fn get_details(&self) -> &Option<String>
Details for terminating the workflow execution.
Sourcepub fn child_policy(self, input: ChildPolicy) -> Self
pub fn child_policy(self, input: ChildPolicy) -> Self
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
Sourcepub fn set_child_policy(self, input: Option<ChildPolicy>) -> Self
pub fn set_child_policy(self, input: Option<ChildPolicy>) -> Self
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
Sourcepub fn get_child_policy(&self) -> &Option<ChildPolicy>
pub fn get_child_policy(&self) -> &Option<ChildPolicy>
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
Sourcepub fn build(self) -> Result<TerminateWorkflowExecutionInput, BuildError>
pub fn build(self) -> Result<TerminateWorkflowExecutionInput, BuildError>
Consumes the builder and constructs a TerminateWorkflowExecutionInput
.
Source§impl TerminateWorkflowExecutionInputBuilder
impl TerminateWorkflowExecutionInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<TerminateWorkflowExecutionOutput, SdkError<TerminateWorkflowExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<TerminateWorkflowExecutionOutput, SdkError<TerminateWorkflowExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for TerminateWorkflowExecutionInputBuilder
impl Clone for TerminateWorkflowExecutionInputBuilder
Source§fn clone(&self) -> TerminateWorkflowExecutionInputBuilder
fn clone(&self) -> TerminateWorkflowExecutionInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for TerminateWorkflowExecutionInputBuilder
impl Default for TerminateWorkflowExecutionInputBuilder
Source§fn default() -> TerminateWorkflowExecutionInputBuilder
fn default() -> TerminateWorkflowExecutionInputBuilder
Source§impl PartialEq for TerminateWorkflowExecutionInputBuilder
impl PartialEq for TerminateWorkflowExecutionInputBuilder
Source§fn eq(&self, other: &TerminateWorkflowExecutionInputBuilder) -> bool
fn eq(&self, other: &TerminateWorkflowExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for TerminateWorkflowExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for TerminateWorkflowExecutionInputBuilder
impl RefUnwindSafe for TerminateWorkflowExecutionInputBuilder
impl Send for TerminateWorkflowExecutionInputBuilder
impl Sync for TerminateWorkflowExecutionInputBuilder
impl Unpin for TerminateWorkflowExecutionInputBuilder
impl UnwindSafe for TerminateWorkflowExecutionInputBuilder
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);