#[non_exhaustive]pub struct DescribeStateMachineInputBuilder { /* private fields */ }
Expand description
A builder for DescribeStateMachineInput
.
Implementations§
Source§impl DescribeStateMachineInputBuilder
impl DescribeStateMachineInputBuilder
Sourcepub fn state_machine_arn(self, input: impl Into<String>) -> Self
pub fn state_machine_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
Sourcepub fn set_state_machine_arn(self, input: Option<String>) -> Self
pub fn set_state_machine_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
Sourcepub fn get_state_machine_arn(&self) -> &Option<String>
pub fn get_state_machine_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
Sourcepub fn included_data(self, input: IncludedData) -> Self
pub fn included_data(self, input: IncludedData) -> Self
If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt
permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY
to get a successful response without the encrypted definition.
When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY
parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt
permission.
Sourcepub fn set_included_data(self, input: Option<IncludedData>) -> Self
pub fn set_included_data(self, input: Option<IncludedData>) -> Self
If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt
permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY
to get a successful response without the encrypted definition.
When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY
parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt
permission.
Sourcepub fn get_included_data(&self) -> &Option<IncludedData>
pub fn get_included_data(&self) -> &Option<IncludedData>
If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt
permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY
to get a successful response without the encrypted definition.
When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY
parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt
permission.
Sourcepub fn build(self) -> Result<DescribeStateMachineInput, BuildError>
pub fn build(self) -> Result<DescribeStateMachineInput, BuildError>
Consumes the builder and constructs a DescribeStateMachineInput
.
Source§impl DescribeStateMachineInputBuilder
impl DescribeStateMachineInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<DescribeStateMachineOutput, SdkError<DescribeStateMachineError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<DescribeStateMachineOutput, SdkError<DescribeStateMachineError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for DescribeStateMachineInputBuilder
impl Clone for DescribeStateMachineInputBuilder
Source§fn clone(&self) -> DescribeStateMachineInputBuilder
fn clone(&self) -> DescribeStateMachineInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for DescribeStateMachineInputBuilder
impl Default for DescribeStateMachineInputBuilder
Source§fn default() -> DescribeStateMachineInputBuilder
fn default() -> DescribeStateMachineInputBuilder
Source§impl PartialEq for DescribeStateMachineInputBuilder
impl PartialEq for DescribeStateMachineInputBuilder
Source§fn eq(&self, other: &DescribeStateMachineInputBuilder) -> bool
fn eq(&self, other: &DescribeStateMachineInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DescribeStateMachineInputBuilder
Auto Trait Implementations§
impl Freeze for DescribeStateMachineInputBuilder
impl RefUnwindSafe for DescribeStateMachineInputBuilder
impl Send for DescribeStateMachineInputBuilder
impl Sync for DescribeStateMachineInputBuilder
impl Unpin for DescribeStateMachineInputBuilder
impl UnwindSafe for DescribeStateMachineInputBuilder
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);