Struct aws_sdk_iotsitewise::types::builders::AssetModelHierarchyBuilder

#[non_exhaustive]
pub struct AssetModelHierarchyBuilder { /* private fields */ }

A builder for AssetModelHierarchy.

Implementations

impl AssetModelHierarchyBuilder

pub fn id(self, input: impl Into<String>) -> Self

The ID of the asset model hierarchy. This ID is a hierarchyId.

• If you are callling UpdateAssetModel to create a new hierarchy: 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 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.

pub fn set_id(self, input: Option<String>) -> Self

The ID of the asset model hierarchy. This ID is a hierarchyId.

• If you are callling UpdateAssetModel to create a new hierarchy: 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 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.

pub fn get_id(&self) -> &Option<String>

The ID of the asset model hierarchy. This ID is a hierarchyId.

• If you are callling UpdateAssetModel to create a new hierarchy: 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 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.

pub fn name(self, input: impl Into<String>) -> Self

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

pub fn get_name(&self) -> &Option<String>

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

pub fn child_asset_model_id(self, input: impl Into<String>) -> Self

The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

This field is required.

pub fn set_child_asset_model_id(self, input: Option<String>) -> Self

The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

pub fn get_child_asset_model_id(&self) -> &Option<String>

The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

pub fn external_id(self, input: impl Into<String>) -> Self

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.

pub fn set_external_id(self, input: Option<String>) -> Self

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.

pub fn get_external_id(&self) -> &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.

pub fn build(self) -> Result<AssetModelHierarchy, BuildError>

Consumes the builder and constructs a AssetModelHierarchy. This method will fail if any of the following fields are not set:

• name
• child_asset_model_id

Trait Implementations

impl Clone for AssetModelHierarchyBuilder

fn clone(&self) -> AssetModelHierarchyBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetModelHierarchyBuilder

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

Formats the value using the given formatter.

impl Default for AssetModelHierarchyBuilder

fn default() -> AssetModelHierarchyBuilder

Returns the “default value” for a type.

impl PartialEq for AssetModelHierarchyBuilder

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