// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateStateTemplateInput {
/// <p>The name of the state template.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>A brief description of the state template.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The ARN of the signal catalog associated with the state template.</p>
pub signal_catalog_arn: ::std::option::Option<::std::string::String>,
/// <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
pub state_template_properties: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p>
pub data_extra_dimensions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.</p>
/// <p>Default: An empty array</p>
pub metadata_extra_dimensions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Metadata that can be used to manage the state template.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateStateTemplateInput {
/// <p>The name of the state template.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>A brief description of the state template.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The ARN of the signal catalog associated with the state template.</p>
pub fn signal_catalog_arn(&self) -> ::std::option::Option<&str> {
self.signal_catalog_arn.as_deref()
}
/// <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.state_template_properties.is_none()`.
pub fn state_template_properties(&self) -> &[::std::string::String] {
self.state_template_properties.as_deref().unwrap_or_default()
}
/// <p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.data_extra_dimensions.is_none()`.
pub fn data_extra_dimensions(&self) -> &[::std::string::String] {
self.data_extra_dimensions.as_deref().unwrap_or_default()
}
/// <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.</p>
/// <p>Default: An empty array</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.metadata_extra_dimensions.is_none()`.
pub fn metadata_extra_dimensions(&self) -> &[::std::string::String] {
self.metadata_extra_dimensions.as_deref().unwrap_or_default()
}
/// <p>Metadata that can be used to manage the state template.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl CreateStateTemplateInput {
/// Creates a new builder-style object to manufacture [`CreateStateTemplateInput`](crate::operation::create_state_template::CreateStateTemplateInput).
pub fn builder() -> crate::operation::create_state_template::builders::CreateStateTemplateInputBuilder {
crate::operation::create_state_template::builders::CreateStateTemplateInputBuilder::default()
}
}
/// A builder for [`CreateStateTemplateInput`](crate::operation::create_state_template::CreateStateTemplateInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateStateTemplateInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) signal_catalog_arn: ::std::option::Option<::std::string::String>,
pub(crate) state_template_properties: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) data_extra_dimensions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) metadata_extra_dimensions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateStateTemplateInputBuilder {
/// <p>The name of the state template.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the state template.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the state template.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>A brief description of the state template.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A brief description of the state template.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A brief description of the state template.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The ARN of the signal catalog associated with the state template.</p>
/// This field is required.
pub fn signal_catalog_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.signal_catalog_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the signal catalog associated with the state template.</p>
pub fn set_signal_catalog_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.signal_catalog_arn = input;
self
}
/// <p>The ARN of the signal catalog associated with the state template.</p>
pub fn get_signal_catalog_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.signal_catalog_arn
}
/// Appends an item to `state_template_properties`.
///
/// To override the contents of this collection use [`set_state_template_properties`](Self::set_state_template_properties).
///
/// <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
pub fn state_template_properties(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.state_template_properties.unwrap_or_default();
v.push(input.into());
self.state_template_properties = ::std::option::Option::Some(v);
self
}
/// <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
pub fn set_state_template_properties(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.state_template_properties = input;
self
}
/// <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
pub fn get_state_template_properties(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.state_template_properties
}
/// Appends an item to `data_extra_dimensions`.
///
/// To override the contents of this collection use [`set_data_extra_dimensions`](Self::set_data_extra_dimensions).
///
/// <p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p>
pub fn data_extra_dimensions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.data_extra_dimensions.unwrap_or_default();
v.push(input.into());
self.data_extra_dimensions = ::std::option::Option::Some(v);
self
}
/// <p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p>
pub fn set_data_extra_dimensions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.data_extra_dimensions = input;
self
}
/// <p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p>
pub fn get_data_extra_dimensions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.data_extra_dimensions
}
/// Appends an item to `metadata_extra_dimensions`.
///
/// To override the contents of this collection use [`set_metadata_extra_dimensions`](Self::set_metadata_extra_dimensions).
///
/// <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.</p>
/// <p>Default: An empty array</p>
pub fn metadata_extra_dimensions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.metadata_extra_dimensions.unwrap_or_default();
v.push(input.into());
self.metadata_extra_dimensions = ::std::option::Option::Some(v);
self
}
/// <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.</p>
/// <p>Default: An empty array</p>
pub fn set_metadata_extra_dimensions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.metadata_extra_dimensions = input;
self
}
/// <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.</p>
/// <p>Default: An empty array</p>
pub fn get_metadata_extra_dimensions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.metadata_extra_dimensions
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Metadata that can be used to manage the state template.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>Metadata that can be used to manage the state template.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>Metadata that can be used to manage the state template.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateStateTemplateInput`](crate::operation::create_state_template::CreateStateTemplateInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_state_template::CreateStateTemplateInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::create_state_template::CreateStateTemplateInput {
name: self.name,
description: self.description,
signal_catalog_arn: self.signal_catalog_arn,
state_template_properties: self.state_template_properties,
data_extra_dimensions: self.data_extra_dimensions,
metadata_extra_dimensions: self.metadata_extra_dimensions,
tags: self.tags,
})
}
}