pub struct UpdateStateTemplateFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateStateTemplate
.
Updates a state template.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
Implementations§
Source§impl UpdateStateTemplateFluentBuilder
impl UpdateStateTemplateFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateStateTemplateInputBuilder
pub fn as_input(&self) -> &UpdateStateTemplateInputBuilder
Access the UpdateStateTemplate as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateStateTemplateOutput, SdkError<UpdateStateTemplateError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateStateTemplateOutput, SdkError<UpdateStateTemplateError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateStateTemplateOutput, UpdateStateTemplateError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateStateTemplateOutput, UpdateStateTemplateError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn identifier(self, input: impl Into<String>) -> Self
pub fn identifier(self, input: impl Into<String>) -> Self
The unique ID of the state template.
Sourcepub fn set_identifier(self, input: Option<String>) -> Self
pub fn set_identifier(self, input: Option<String>) -> Self
The unique ID of the state template.
Sourcepub fn get_identifier(&self) -> &Option<String>
pub fn get_identifier(&self) -> &Option<String>
The unique ID of the state template.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A brief description of the state template.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A brief description of the state template.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A brief description of the state template.
Sourcepub fn state_template_properties_to_add(self, input: impl Into<String>) -> Self
pub fn state_template_properties_to_add(self, input: impl Into<String>) -> Self
Appends an item to stateTemplatePropertiesToAdd
.
To override the contents of this collection use set_state_template_properties_to_add
.
Add signals from which data is collected as part of the state template.
Sourcepub fn set_state_template_properties_to_add(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_state_template_properties_to_add( self, input: Option<Vec<String>>, ) -> Self
Add signals from which data is collected as part of the state template.
Sourcepub fn get_state_template_properties_to_add(&self) -> &Option<Vec<String>>
pub fn get_state_template_properties_to_add(&self) -> &Option<Vec<String>>
Add signals from which data is collected as part of the state template.
Sourcepub fn state_template_properties_to_remove(
self,
input: impl Into<String>,
) -> Self
pub fn state_template_properties_to_remove( self, input: impl Into<String>, ) -> Self
Appends an item to stateTemplatePropertiesToRemove
.
To override the contents of this collection use set_state_template_properties_to_remove
.
Remove signals from which data is collected as part of the state template.
Sourcepub fn set_state_template_properties_to_remove(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_state_template_properties_to_remove( self, input: Option<Vec<String>>, ) -> Self
Remove signals from which data is collected as part of the state template.
Sourcepub fn get_state_template_properties_to_remove(&self) -> &Option<Vec<String>>
pub fn get_state_template_properties_to_remove(&self) -> &Option<Vec<String>>
Remove signals from which data is collected as part of the state template.
Sourcepub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
pub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
Appends an item to dataExtraDimensions
.
To override the contents of this collection use set_data_extra_dimensions
.
A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions
field.
Default: An empty array
Sourcepub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
pub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions
field.
Default: An empty array
Sourcepub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
pub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions
field.
Default: An empty array
Sourcepub fn metadata_extra_dimensions(self, input: impl Into<String>) -> Self
pub fn metadata_extra_dimensions(self, input: impl Into<String>) -> Self
Appends an item to metadataExtraDimensions
.
To override the contents of this collection use set_metadata_extra_dimensions
.
A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
Sourcepub fn set_metadata_extra_dimensions(self, input: Option<Vec<String>>) -> Self
pub fn set_metadata_extra_dimensions(self, input: Option<Vec<String>>) -> Self
A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
Sourcepub fn get_metadata_extra_dimensions(&self) -> &Option<Vec<String>>
pub fn get_metadata_extra_dimensions(&self) -> &Option<Vec<String>>
A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
Trait Implementations§
Source§impl Clone for UpdateStateTemplateFluentBuilder
impl Clone for UpdateStateTemplateFluentBuilder
Source§fn clone(&self) -> UpdateStateTemplateFluentBuilder
fn clone(&self) -> UpdateStateTemplateFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateStateTemplateFluentBuilder
impl !RefUnwindSafe for UpdateStateTemplateFluentBuilder
impl Send for UpdateStateTemplateFluentBuilder
impl Sync for UpdateStateTemplateFluentBuilder
impl Unpin for UpdateStateTemplateFluentBuilder
impl !UnwindSafe for UpdateStateTemplateFluentBuilder
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);