#[non_exhaustive]pub struct IotEventsActionBuilder { /* private fields */ }
Expand description
A builder for IotEventsAction
.
Implementations§
Source§impl IotEventsActionBuilder
impl IotEventsActionBuilder
Sourcepub fn input_name(self, input: impl Into<String>) -> Self
pub fn input_name(self, input: impl Into<String>) -> Self
The name of the IoT Events input.
This field is required.Sourcepub fn set_input_name(self, input: Option<String>) -> Self
pub fn set_input_name(self, input: Option<String>) -> Self
The name of the IoT Events input.
Sourcepub fn get_input_name(&self) -> &Option<String>
pub fn get_input_name(&self) -> &Option<String>
The name of the IoT Events input.
Sourcepub fn message_id(self, input: impl Into<String>) -> Self
pub fn message_id(self, input: impl Into<String>) -> Self
The ID of the message. The default messageId
is a new UUID value.
When batchMode
is true
, you can't specify a messageId
--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId
will be processed by an IoT Events detector.
Sourcepub fn set_message_id(self, input: Option<String>) -> Self
pub fn set_message_id(self, input: Option<String>) -> Self
The ID of the message. The default messageId
is a new UUID value.
When batchMode
is true
, you can't specify a messageId
--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId
will be processed by an IoT Events detector.
Sourcepub fn get_message_id(&self) -> &Option<String>
pub fn get_message_id(&self) -> &Option<String>
The ID of the message. The default messageId
is a new UUID value.
When batchMode
is true
, you can't specify a messageId
--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId
will be processed by an IoT Events detector.
Sourcepub fn batch_mode(self, input: bool) -> Self
pub fn batch_mode(self, input: bool) -> Self
Whether to process the event actions as a batch. The default value is false
.
When batchMode
is true
, you can't specify a messageId
.
When batchMode
is true
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage
. The resulting array can't have more than 10 messages.
Sourcepub fn set_batch_mode(self, input: Option<bool>) -> Self
pub fn set_batch_mode(self, input: Option<bool>) -> Self
Whether to process the event actions as a batch. The default value is false
.
When batchMode
is true
, you can't specify a messageId
.
When batchMode
is true
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage
. The resulting array can't have more than 10 messages.
Sourcepub fn get_batch_mode(&self) -> &Option<bool>
pub fn get_batch_mode(&self) -> &Option<bool>
Whether to process the event actions as a batch. The default value is false
.
When batchMode
is true
, you can't specify a messageId
.
When batchMode
is true
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage
. The resulting array can't have more than 10 messages.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
Sourcepub fn build(self) -> Result<IotEventsAction, BuildError>
pub fn build(self) -> Result<IotEventsAction, BuildError>
Consumes the builder and constructs a IotEventsAction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for IotEventsActionBuilder
impl Clone for IotEventsActionBuilder
Source§fn clone(&self) -> IotEventsActionBuilder
fn clone(&self) -> IotEventsActionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for IotEventsActionBuilder
impl Debug for IotEventsActionBuilder
Source§impl Default for IotEventsActionBuilder
impl Default for IotEventsActionBuilder
Source§fn default() -> IotEventsActionBuilder
fn default() -> IotEventsActionBuilder
Source§impl PartialEq for IotEventsActionBuilder
impl PartialEq for IotEventsActionBuilder
impl StructuralPartialEq for IotEventsActionBuilder
Auto Trait Implementations§
impl Freeze for IotEventsActionBuilder
impl RefUnwindSafe for IotEventsActionBuilder
impl Send for IotEventsActionBuilder
impl Sync for IotEventsActionBuilder
impl Unpin for IotEventsActionBuilder
impl UnwindSafe for IotEventsActionBuilder
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);