Struct aws_sdk_iotsitewise::types::VariableValue

#[non_exhaustive]
pub struct VariableValue {
    pub property_id: Option<String>,
    pub hierarchy_id: Option<String>,
    pub property_path: Option<Vec<AssetModelPropertyPathSegment>>,
}

Identifies a property value used in an expression.

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.

property_id: Option<String>

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

hierarchy_id: Option<String>

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

property_path: Option<Vec<AssetModelPropertyPathSegment>>

The path of the property.

Implementations

impl VariableValue

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

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

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

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

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

The path of the property.

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

impl VariableValue

pub fn builder() -> VariableValueBuilder

Creates a new builder-style object to manufacture VariableValue.

Trait Implementations

impl Clone for VariableValue

fn clone(&self) -> VariableValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariableValue

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

Formats the value using the given formatter.

impl PartialEq for VariableValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for VariableValue