Struct AssetModelPropertySummary 

#[non_exhaustive]
pub struct AssetModelPropertySummary {
    pub id: Option<String>,
    pub external_id: Option<String>,
    pub name: String,
    pub data_type: PropertyDataType,
    pub data_type_spec: Option<String>,
    pub unit: Option<String>,
    pub type: Option<PropertyType>,
    pub asset_model_composite_model_id: Option<String>,
    pub path: Option<Vec<AssetModelPropertyPathSegment>>,
    pub interface_summaries: Option<Vec<InterfaceSummary>>,
}

Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.

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: Option<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.

name: String

The name of the property.

data_type: PropertyDataType

The data type of the property.

data_type_spec: Option<String>

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

unit: Option<String>

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

type: Option<PropertyType>

Contains a property type, which can be one of attribute, measurement, metric, or transform.

asset_model_composite_model_id: Option<String>

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

path: Option<Vec<AssetModelPropertyPathSegment>>

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

interface_summaries: Option<Vec<InterfaceSummary>>

A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

Implementations

impl AssetModelPropertySummary

pub fn id(&self) -> Option<&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 name(&self) -> &str

The name of the property.

pub fn data_type(&self) -> &PropertyDataType

The data type of the property.

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

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

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

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

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

Contains a property type, which can be one of attribute, measurement, metric, or transform.

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

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

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

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

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().

pub fn interface_summaries(&self) -> &[InterfaceSummary]

A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

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

impl AssetModelPropertySummary

pub fn builder() -> AssetModelPropertySummaryBuilder

Creates a new builder-style object to manufacture AssetModelPropertySummary.

Trait Implementations

impl Clone for AssetModelPropertySummary

fn clone(&self) -> AssetModelPropertySummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelPropertySummary

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

Formats the value using the given formatter.

impl PartialEq for AssetModelPropertySummary

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