Struct AssetPropertySummary 

#[non_exhaustive]
pub struct AssetPropertySummary {
    pub id: String,
    pub external_id: Option<String>,
    pub alias: Option<String>,
    pub unit: Option<String>,
    pub notification: Option<PropertyNotification>,
    pub asset_composite_model_id: Option<String>,
    pub path: Option<Vec<AssetPropertyPathSegment>>,
}

Contains a summary of a property associated with an asset.

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.

id: String

The ID of the property.

external_id: Option<String>

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

alias: Option<String>

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

unit: Option<String>

The unit of measure (such as Newtons or RPM) of the asset property.

notification: Option<PropertyNotification>

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

asset_composite_model_id: Option<String>

The ID of the composite model that contains the asset property.

path: Option<Vec<AssetPropertyPathSegment>>

The structured path to the property from the root of the asset.

Implementations

impl AssetPropertySummary

pub fn id(&self) -> &str

The ID of the property.

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

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

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

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

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

The unit of measure (such as Newtons or RPM) of the asset property.

pub fn notification(&self) -> Option<&PropertyNotification>

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

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

The ID of the composite model that contains the asset property.

pub fn path(&self) -> &[AssetPropertyPathSegment]

The structured path to the property from the root of the asset.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .path.is_none().

impl AssetPropertySummary

pub fn builder() -> AssetPropertySummaryBuilder

Creates a new builder-style object to manufacture AssetPropertySummary.

Trait Implementations

impl Clone for AssetPropertySummary

fn clone(&self) -> AssetPropertySummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetPropertySummary

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

Formats the value using the given formatter.

impl PartialEq for AssetPropertySummary

fn eq(&self, other: &AssetPropertySummary) -> 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 AssetPropertySummary