Struct AssetModelHierarchyDefinition

#[non_exhaustive]
pub struct AssetModelHierarchyDefinition {
    pub id: Option<String>,
    pub external_id: Option<String>,
    pub name: String,
    pub child_asset_model_id: String,
}

Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

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

name: String

The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

child_asset_model_id: String

The ID of an asset model for this hierarchy. 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.

Implementations

impl AssetModelHierarchyDefinition

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

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

pub fn name(&self) -> &str

The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

pub fn child_asset_model_id(&self) -> &str

The ID of an asset model for this hierarchy. 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.

impl AssetModelHierarchyDefinition

pub fn builder() -> AssetModelHierarchyDefinitionBuilder

Creates a new builder-style object to manufacture AssetModelHierarchyDefinition.

Trait Implementations

impl Clone for AssetModelHierarchyDefinition

fn clone(&self) -> AssetModelHierarchyDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelHierarchyDefinition

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

Formats the value using the given formatter.

impl PartialEq for AssetModelHierarchyDefinition

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