Struct aws_sdk_iotsitewise::types::AssetModelPropertyDefinition

#[non_exhaustive]
pub struct AssetModelPropertyDefinition {
    pub name: String,
    pub data_type: PropertyDataType,
    pub data_type_spec: Option<String>,
    pub unit: Option<String>,
    pub type: Option<PropertyType>,
    pub id: Option<String>,
    pub external_id: Option<String>,
}

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

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

data_type: PropertyDataType

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

data_type_spec: Option<String>

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

The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.

unit: Option<String>

The unit of the property definition, such as Newtons or RPM.

type: Option<PropertyType>

The property definition type (see PropertyType). You can only specify one type in a property definition.

id: Option<String>

The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

external_id: Option<String>

An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

Implementations

impl AssetModelPropertyDefinition

pub fn name(&self) -> &str

The name of the property definition.

pub fn data_type(&self) -> &PropertyDataType

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

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

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

The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.

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

The unit of the property definition, such as Newtons or RPM.

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

The property definition type (see PropertyType). You can only specify one type in a property definition.

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

The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

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

An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

impl AssetModelPropertyDefinition

pub fn builder() -> AssetModelPropertyDefinitionBuilder

Creates a new builder-style object to manufacture AssetModelPropertyDefinition.

Trait Implementations

impl Clone for AssetModelPropertyDefinition

fn clone(&self) -> AssetModelPropertyDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelPropertyDefinition

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

Formats the value using the given formatter.

impl PartialEq for AssetModelPropertyDefinition

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