#[non_exhaustive]pub struct TestStateInputBuilder { /* private fields */ }
Expand description
A builder for TestStateInput
.
Implementations§
Source§impl TestStateInputBuilder
impl TestStateInputBuilder
Sourcepub fn definition(self, input: impl Into<String>) -> Self
pub fn definition(self, input: impl Into<String>) -> Self
The Amazon States Language (ASL) definition of the state.
This field is required.Sourcepub fn set_definition(self, input: Option<String>) -> Self
pub fn set_definition(self, input: Option<String>) -> Self
The Amazon States Language (ASL) definition of the state.
Sourcepub fn get_definition(&self) -> &Option<String>
pub fn get_definition(&self) -> &Option<String>
The Amazon States Language (ASL) definition of the state.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn input(self, input: impl Into<String>) -> Self
pub fn input(self, input: impl Into<String>) -> Self
A string that contains the JSON input data for the state.
Sourcepub fn set_input(self, input: Option<String>) -> Self
pub fn set_input(self, input: Option<String>) -> Self
A string that contains the JSON input data for the state.
Sourcepub fn get_input(&self) -> &Option<String>
pub fn get_input(&self) -> &Option<String>
A string that contains the JSON input data for the state.
Sourcepub fn inspection_level(self, input: InspectionLevel) -> Self
pub fn inspection_level(self, input: InspectionLevel) -> Self
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO
: Shows the final state output. By default, Step Functions setsinspectionLevel
toINFO
if you don't specify a level. -
DEBUG
: Shows the final state output along with the input and output data processing result. -
TRACE
: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn set_inspection_level(self, input: Option<InspectionLevel>) -> Self
pub fn set_inspection_level(self, input: Option<InspectionLevel>) -> Self
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO
: Shows the final state output. By default, Step Functions setsinspectionLevel
toINFO
if you don't specify a level. -
DEBUG
: Shows the final state output along with the input and output data processing result. -
TRACE
: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn get_inspection_level(&self) -> &Option<InspectionLevel>
pub fn get_inspection_level(&self) -> &Option<InspectionLevel>
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO
: Shows the final state output. By default, Step Functions setsinspectionLevel
toINFO
if you don't specify a level. -
DEBUG
: Shows the final state output along with the input and output data processing result. -
TRACE
: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn reveal_secrets(self, input: bool) -> Self
pub fn reveal_secrets(self, input: bool) -> Self
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets
to true
, you must make sure that the IAM user that calls the TestState
API has permission for the states:RevealSecrets
action. For an example of IAM policy that sets the states:RevealSecrets
permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets
is set to false
.
Sourcepub fn set_reveal_secrets(self, input: Option<bool>) -> Self
pub fn set_reveal_secrets(self, input: Option<bool>) -> Self
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets
to true
, you must make sure that the IAM user that calls the TestState
API has permission for the states:RevealSecrets
action. For an example of IAM policy that sets the states:RevealSecrets
permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets
is set to false
.
Sourcepub fn get_reveal_secrets(&self) -> &Option<bool>
pub fn get_reveal_secrets(&self) -> &Option<bool>
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets
to true
, you must make sure that the IAM user that calls the TestState
API has permission for the states:RevealSecrets
action. For an example of IAM policy that sets the states:RevealSecrets
permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets
is set to false
.
Sourcepub fn variables(self, input: impl Into<String>) -> Self
pub fn variables(self, input: impl Into<String>) -> Self
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Sourcepub fn set_variables(self, input: Option<String>) -> Self
pub fn set_variables(self, input: Option<String>) -> Self
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Sourcepub fn get_variables(&self) -> &Option<String>
pub fn get_variables(&self) -> &Option<String>
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Sourcepub fn build(self) -> Result<TestStateInput, BuildError>
pub fn build(self) -> Result<TestStateInput, BuildError>
Consumes the builder and constructs a TestStateInput
.
Source§impl TestStateInputBuilder
impl TestStateInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<TestStateOutput, SdkError<TestStateError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<TestStateOutput, SdkError<TestStateError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for TestStateInputBuilder
impl Clone for TestStateInputBuilder
Source§fn clone(&self) -> TestStateInputBuilder
fn clone(&self) -> TestStateInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TestStateInputBuilder
impl Debug for TestStateInputBuilder
Source§impl Default for TestStateInputBuilder
impl Default for TestStateInputBuilder
Source§fn default() -> TestStateInputBuilder
fn default() -> TestStateInputBuilder
Source§impl PartialEq for TestStateInputBuilder
impl PartialEq for TestStateInputBuilder
impl StructuralPartialEq for TestStateInputBuilder
Auto Trait Implementations§
impl Freeze for TestStateInputBuilder
impl RefUnwindSafe for TestStateInputBuilder
impl Send for TestStateInputBuilder
impl Sync for TestStateInputBuilder
impl Unpin for TestStateInputBuilder
impl UnwindSafe for TestStateInputBuilder
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);