Class: Aws::IoTFleetWise::Types::UpdateStateTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::UpdateStateTemplateRequest

Defined in:

gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_extra_dimensions ⇒ Array<String>

  A list of vehicle attributes to associate with the payload published on the state template's MQTT topic.

• #description ⇒ String

  A brief description of the state template.

• #identifier ⇒ String

  The unique ID of the state template.

• #metadata_extra_dimensions ⇒ Array<String>

  A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

• #state_template_properties_to_add ⇒ Array<String>

  Add signals from which data is collected as part of the state template.

• #state_template_properties_to_remove ⇒ Array<String>

  Remove signals from which data is collected as part of the state template.

Instance Attribute Details

#data_extra_dimensions ⇒ Array<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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A brief description of the state template.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The unique ID of the state template.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_extra_dimensions ⇒ Array<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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#state_template_properties_to_add ⇒ Array<String>

Add signals from which data is collected as part of the state template.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#state_template_properties_to_remove ⇒ Array<String>

Remove signals from which data is collected as part of the state template.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 5087

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end