Struct aws_sdk_iotsitewise::types::AssetModelProperty

#[non_exhaustive]
pub struct AssetModelProperty {
    pub 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 path: Option<Vec<AssetModelPropertyPathSegment>>,
    pub external_id: Option<String>,
}

Contains information about an asset model property.

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

• If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.

• If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

name: String

The name of the asset model property.

data_type: PropertyDataType

The data type of the asset model 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 of the asset model property, such as Newtons or RPM.

type: Option<PropertyType>

The property type (see PropertyType).

path: Option<Vec<AssetModelPropertyPathSegment>>

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

external_id: Option<String>

The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

Implementations

impl AssetModelProperty

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

The ID of the asset model property.

• If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.

• If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

pub fn name(&self) -> &str

The name of the asset model property.

pub fn data_type(&self) -> &PropertyDataType

The data type of the asset model 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 of the asset model property, such as Newtons or RPM.

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

The property type (see PropertyType).

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 external_id(&self) -> Option<&str>

The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

impl AssetModelProperty

pub fn builder() -> AssetModelPropertyBuilder

Creates a new builder-style object to manufacture AssetModelProperty.

Trait Implementations

impl Clone for AssetModelProperty

fn clone(&self) -> AssetModelProperty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelProperty

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

Formats the value using the given formatter.

impl PartialEq for AssetModelProperty

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