#[non_exhaustive]pub struct GetCommandExecutionOutputBuilder { /* private fields */ }
Expand description
A builder for GetCommandExecutionOutput
.
Implementations§
Source§impl GetCommandExecutionOutputBuilder
impl GetCommandExecutionOutputBuilder
Sourcepub fn execution_id(self, input: impl Into<String>) -> Self
pub fn execution_id(self, input: impl Into<String>) -> Self
The unique identifier of the command execution.
Sourcepub fn set_execution_id(self, input: Option<String>) -> Self
pub fn set_execution_id(self, input: Option<String>) -> Self
The unique identifier of the command execution.
Sourcepub fn get_execution_id(&self) -> &Option<String>
pub fn get_execution_id(&self) -> &Option<String>
The unique identifier of the command execution.
Sourcepub fn command_arn(self, input: impl Into<String>) -> Self
pub fn command_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:
Sourcepub fn set_command_arn(self, input: Option<String>) -> Self
pub fn set_command_arn(self, input: Option<String>) -> Self
The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:
Sourcepub fn get_command_arn(&self) -> &Option<String>
pub fn get_command_arn(&self) -> &Option<String>
The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:
Sourcepub fn target_arn(self, input: impl Into<String>) -> Self
pub fn target_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Number (ARN) of the device on which the command execution is being performed.
Sourcepub fn set_target_arn(self, input: Option<String>) -> Self
pub fn set_target_arn(self, input: Option<String>) -> Self
The Amazon Resource Number (ARN) of the device on which the command execution is being performed.
Sourcepub fn get_target_arn(&self) -> &Option<String>
pub fn get_target_arn(&self) -> &Option<String>
The Amazon Resource Number (ARN) of the device on which the command execution is being performed.
Sourcepub fn status(self, input: CommandExecutionStatus) -> Self
pub fn status(self, input: CommandExecutionStatus) -> Self
The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution
MQTT API to update the status information.
Sourcepub fn set_status(self, input: Option<CommandExecutionStatus>) -> Self
pub fn set_status(self, input: Option<CommandExecutionStatus>) -> Self
The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution
MQTT API to update the status information.
Sourcepub fn get_status(&self) -> &Option<CommandExecutionStatus>
pub fn get_status(&self) -> &Option<CommandExecutionStatus>
The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution
MQTT API to update the status information.
Sourcepub fn status_reason(self, input: StatusReason) -> Self
pub fn status_reason(self, input: StatusReason) -> Self
Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.
Sourcepub fn set_status_reason(self, input: Option<StatusReason>) -> Self
pub fn set_status_reason(self, input: Option<StatusReason>) -> Self
Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.
Sourcepub fn get_status_reason(&self) -> &Option<StatusReason>
pub fn get_status_reason(&self) -> &Option<StatusReason>
Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.
Sourcepub fn result(self, k: impl Into<String>, v: CommandExecutionResult) -> Self
pub fn result(self, k: impl Into<String>, v: CommandExecutionResult) -> Self
Adds a key-value pair to result
.
To override the contents of this collection use set_result
.
The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.
If you use the AWS-IoT-FleetWise
namespace, then this field is not applicable in the API response.
Sourcepub fn set_result(
self,
input: Option<HashMap<String, CommandExecutionResult>>,
) -> Self
pub fn set_result( self, input: Option<HashMap<String, CommandExecutionResult>>, ) -> Self
The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.
If you use the AWS-IoT-FleetWise
namespace, then this field is not applicable in the API response.
Sourcepub fn get_result(&self) -> &Option<HashMap<String, CommandExecutionResult>>
pub fn get_result(&self) -> &Option<HashMap<String, CommandExecutionResult>>
The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.
If you use the AWS-IoT-FleetWise
namespace, then this field is not applicable in the API response.
Sourcepub fn parameters(self, k: impl Into<String>, v: CommandParameterValue) -> Self
pub fn parameters(self, k: impl Into<String>, v: CommandParameterValue) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
The list of parameters that the StartCommandExecution
API used when performing the command on the device.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, CommandParameterValue>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, CommandParameterValue>>, ) -> Self
The list of parameters that the StartCommandExecution
API used when performing the command on the device.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, CommandParameterValue>>
pub fn get_parameters(&self) -> &Option<HashMap<String, CommandParameterValue>>
The list of parameters that the StartCommandExecution
API used when performing the command on the device.
Sourcepub fn execution_timeout_seconds(self, input: i64) -> Self
pub fn execution_timeout_seconds(self, input: i64) -> Self
Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT
.
Sourcepub fn set_execution_timeout_seconds(self, input: Option<i64>) -> Self
pub fn set_execution_timeout_seconds(self, input: Option<i64>) -> Self
Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT
.
Sourcepub fn get_execution_timeout_seconds(&self) -> &Option<i64>
pub fn get_execution_timeout_seconds(&self) -> &Option<i64>
Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT
.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The timestamp, when the command execution was created.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The timestamp, when the command execution was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The timestamp, when the command execution was created.
Sourcepub fn last_updated_at(self, input: DateTime) -> Self
pub fn last_updated_at(self, input: DateTime) -> Self
The timestamp, when the command execution was last updated.
Sourcepub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
The timestamp, when the command execution was last updated.
Sourcepub fn get_last_updated_at(&self) -> &Option<DateTime>
pub fn get_last_updated_at(&self) -> &Option<DateTime>
The timestamp, when the command execution was last updated.
Sourcepub fn started_at(self, input: DateTime) -> Self
pub fn started_at(self, input: DateTime) -> Self
The timestamp, when the command execution was started.
Sourcepub fn set_started_at(self, input: Option<DateTime>) -> Self
pub fn set_started_at(self, input: Option<DateTime>) -> Self
The timestamp, when the command execution was started.
Sourcepub fn get_started_at(&self) -> &Option<DateTime>
pub fn get_started_at(&self) -> &Option<DateTime>
The timestamp, when the command execution was started.
Sourcepub fn completed_at(self, input: DateTime) -> Self
pub fn completed_at(self, input: DateTime) -> Self
The timestamp, when the command execution was completed.
Sourcepub fn set_completed_at(self, input: Option<DateTime>) -> Self
pub fn set_completed_at(self, input: Option<DateTime>) -> Self
The timestamp, when the command execution was completed.
Sourcepub fn get_completed_at(&self) -> &Option<DateTime>
pub fn get_completed_at(&self) -> &Option<DateTime>
The timestamp, when the command execution was completed.
Sourcepub fn time_to_live(self, input: DateTime) -> Self
pub fn time_to_live(self, input: DateTime) -> Self
The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.
Sourcepub fn set_time_to_live(self, input: Option<DateTime>) -> Self
pub fn set_time_to_live(self, input: Option<DateTime>) -> Self
The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.
Sourcepub fn get_time_to_live(&self) -> &Option<DateTime>
pub fn get_time_to_live(&self) -> &Option<DateTime>
The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.
Sourcepub fn build(self) -> GetCommandExecutionOutput
pub fn build(self) -> GetCommandExecutionOutput
Consumes the builder and constructs a GetCommandExecutionOutput
.
Trait Implementations§
Source§impl Clone for GetCommandExecutionOutputBuilder
impl Clone for GetCommandExecutionOutputBuilder
Source§fn clone(&self) -> GetCommandExecutionOutputBuilder
fn clone(&self) -> GetCommandExecutionOutputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for GetCommandExecutionOutputBuilder
impl Default for GetCommandExecutionOutputBuilder
Source§fn default() -> GetCommandExecutionOutputBuilder
fn default() -> GetCommandExecutionOutputBuilder
Source§impl PartialEq for GetCommandExecutionOutputBuilder
impl PartialEq for GetCommandExecutionOutputBuilder
Source§fn eq(&self, other: &GetCommandExecutionOutputBuilder) -> bool
fn eq(&self, other: &GetCommandExecutionOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GetCommandExecutionOutputBuilder
Auto Trait Implementations§
impl Freeze for GetCommandExecutionOutputBuilder
impl RefUnwindSafe for GetCommandExecutionOutputBuilder
impl Send for GetCommandExecutionOutputBuilder
impl Sync for GetCommandExecutionOutputBuilder
impl Unpin for GetCommandExecutionOutputBuilder
impl UnwindSafe for GetCommandExecutionOutputBuilder
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);