Struct aws_sdk_iotsitewise::types::AssetModelCompositeModelDefinition

#[non_exhaustive]
pub struct AssetModelCompositeModelDefinition {
    pub name: String,
    pub description: Option<String>,
    pub type: String,
    pub properties: Option<Vec<AssetModelPropertyDefinition>>,
    pub id: Option<String>,
    pub external_id: Option<String>,
}

Contains a composite model definition in an asset model. This composite model 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 composite model.

description: Option<String>

The description of the composite model.

type: String

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

properties: Option<Vec<AssetModelPropertyDefinition>>

The asset property definitions for this composite model.

id: Option<String>

The ID to assign to the composite model, 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 composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

Implementations

impl AssetModelCompositeModelDefinition

pub fn name(&self) -> &str

The name of the composite model.

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

The description of the composite model.

pub fn type(&self) -> &str

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

pub fn properties(&self) -> &[AssetModelPropertyDefinition]

The asset property definitions for this composite 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 .properties.is_none().

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

The ID to assign to the composite model, 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 composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

impl AssetModelCompositeModelDefinition

pub fn builder() -> AssetModelCompositeModelDefinitionBuilder

Creates a new builder-style object to manufacture AssetModelCompositeModelDefinition.

Trait Implementations

impl Clone for AssetModelCompositeModelDefinition

fn clone(&self) -> AssetModelCompositeModelDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelCompositeModelDefinition

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

Formats the value using the given formatter.

impl PartialEq for AssetModelCompositeModelDefinition

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