Struct aws_sdk_iotsitewise::operation::create_asset_model::builders::CreateAssetModelFluentBuilder

pub struct CreateAssetModelFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAssetModel.

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Implementations

impl CreateAssetModelFluentBuilder

pub fn as_input(&self) -> &CreateAssetModelInputBuilder

Access the CreateAssetModel as a reference.

pub async fn send( self ) -> Result<CreateAssetModelOutput, SdkError<CreateAssetModelError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateAssetModelOutput, CreateAssetModelError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

A unique, friendly name for the asset model.

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

A unique, friendly name for the asset model.

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

A unique, friendly name for the asset model.

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

A description for the asset model.

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

A description for the asset model.

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

A description for the asset model.

pub fn asset_model_properties(self, input: AssetModelPropertyDefinition) -> Self

Appends an item to assetModelProperties.

To override the contents of this collection use set_asset_model_properties.

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn set_asset_model_properties( self, input: Option<Vec<AssetModelPropertyDefinition>> ) -> Self

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn get_asset_model_properties( &self ) -> &Option<Vec<AssetModelPropertyDefinition>>

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn asset_model_hierarchies( self, input: AssetModelHierarchyDefinition ) -> Self

Appends an item to assetModelHierarchies.

To override the contents of this collection use set_asset_model_hierarchies.

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn set_asset_model_hierarchies( self, input: Option<Vec<AssetModelHierarchyDefinition>> ) -> Self

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn get_asset_model_hierarchies( &self ) -> &Option<Vec<AssetModelHierarchyDefinition>>

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

pub fn asset_model_composite_models( self, input: AssetModelCompositeModelDefinition ) -> Self

Appends an item to assetModelCompositeModels.

To override the contents of this collection use set_asset_model_composite_models.

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see .

pub fn set_asset_model_composite_models( self, input: Option<Vec<AssetModelCompositeModelDefinition>> ) -> Self

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see .

pub fn get_asset_model_composite_models( &self ) -> &Option<Vec<AssetModelCompositeModelDefinition>>

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see .

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

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

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

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

The ID to assign to the asset 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 set_asset_model_id(self, input: Option<String>) -> Self

The ID to assign to the asset 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 get_asset_model_id(&self) -> &Option<String>

The ID to assign to the asset 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 asset_model_external_id(self, input: impl Into<String>) -> Self

An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

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

An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

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

An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

pub fn asset_model_type(self, input: AssetModelType) -> Self

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

pub fn set_asset_model_type(self, input: Option<AssetModelType>) -> Self

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

pub fn get_asset_model_type(&self) -> &Option<AssetModelType>

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Trait Implementations

impl Clone for CreateAssetModelFluentBuilder

fn clone(&self) -> CreateAssetModelFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAssetModelFluentBuilder

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

Formats the value using the given formatter.