Struct SignalInformation

#[non_exhaustive]
pub struct SignalInformation {
    pub name: String,
    pub max_sample_count: Option<i64>,
    pub minimum_sampling_interval_ms: Option<i64>,
    pub data_partition_id: Option<String>,
}

Information about a signal.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the signal.

max_sample_count: Option<i64>

The maximum number of samples to collect.

minimum_sampling_interval_ms: Option<i64>

The minimum duration of time (in milliseconds) between two triggering events to collect data.

If a signal changes often, you might want to collect data at a slower rate.

data_partition_id: Option<String>

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

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

impl SignalInformation

pub fn name(&self) -> &str

The name of the signal.

pub fn max_sample_count(&self) -> Option<i64>

The maximum number of samples to collect.

pub fn minimum_sampling_interval_ms(&self) -> Option<i64>

The minimum duration of time (in milliseconds) between two triggering events to collect data.

If a signal changes often, you might want to collect data at a slower rate.

pub fn data_partition_id(&self) -> Option<&str>

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

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.

impl SignalInformation

pub fn builder() -> SignalInformationBuilder

Creates a new builder-style object to manufacture SignalInformation.

Trait Implementations

impl Clone for SignalInformation

fn clone(&self) -> SignalInformation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalInformation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SignalInformation

fn eq(&self, other: &SignalInformation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SignalInformation