Struct Property 

#[non_exhaustive]
pub struct Property {
    pub id: String,
    pub external_id: Option<String>,
    pub name: String,
    pub alias: Option<String>,
    pub notification: Option<PropertyNotification>,
    pub data_type: PropertyDataType,
    pub unit: Option<String>,
    pub type: Option<PropertyType>,
    pub path: Option<Vec<AssetPropertyPathSegment>>,
}

Contains asset property information.

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 asset property.

external_id: Option<String>

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

name: String

The name of the property.

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.

notification: Option<PropertyNotification>

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

data_type: PropertyDataType

The property data type.

unit: Option<String>

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

type: Option<PropertyType>

The property type (see PropertyType). A property contains one type.

path: Option<Vec<AssetPropertyPathSegment>>

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

Implementations

impl Property

pub fn id(&self) -> &str

The ID of the asset property.

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

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

pub fn name(&self) -> &str

The name of the property.

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 notification(&self) -> Option<&PropertyNotification>

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

pub fn data_type(&self) -> &PropertyDataType

The property data type.

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

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

pub fn type(&self) -> Option<&PropertyType>

The property type (see PropertyType). A property contains one type.

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 Property

pub fn builder() -> PropertyBuilder

Creates a new builder-style object to manufacture Property.

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl PartialEq for Property

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