Struct aws_sdk_iotsitewise::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder

pub struct CreateAssetModelCompositeModelFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAssetModelCompositeModel.

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Implementations

impl CreateAssetModelCompositeModelFluentBuilder

pub fn as_input(&self) -> &CreateAssetModelCompositeModelInputBuilder

Access the CreateAssetModelCompositeModel as a reference.

pub async fn send( self ) -> Result<CreateAssetModelCompositeModelOutput, SdkError<CreateAssetModelCompositeModelError, 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<CreateAssetModelCompositeModelOutput, CreateAssetModelCompositeModelError, Self>

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

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

The ID of the asset model this composite model is a part of.

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

The ID of the asset model this composite model is a part of.

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

The ID of the asset model this composite model is a part of.

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

The ID of the parent composite model in this asset model relationship.

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

The ID of the parent composite model in this asset model relationship.

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

The ID of the parent composite model in this asset model relationship.

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

An external ID to assign to the composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

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

An external ID to assign to the composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

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

An external ID to assign to the composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

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

The ID of the composite model. 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_composite_model_id(self, input: Option<String>) -> Self

The ID of the composite model. 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_composite_model_id(&self) -> &Option<String>

The ID of the composite model. 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_composite_model_description( self, input: impl Into<String> ) -> Self

A description for the composite model.

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

A description for the composite model.

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

A description for the composite model.

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

A unique, friendly name for the composite model.

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

A unique, friendly name for the composite model.

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

A unique, friendly name for the composite model.

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

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

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

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

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

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

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 composed_asset_model_id(self, input: impl Into<String>) -> Self

The ID of a composite model on this asset.

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

The ID of a composite model on this asset.

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

The ID of a composite model on this asset.

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

Appends an item to assetModelCompositeModelProperties.

To override the contents of this collection use set_asset_model_composite_model_properties.

The property definitions of the composite model. For more information, see .

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

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

The property definitions of the composite model. For more information, see .

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

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

The property definitions of the composite model. For more information, see .

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

Trait Implementations

impl Clone for CreateAssetModelCompositeModelFluentBuilder

fn clone(&self) -> CreateAssetModelCompositeModelFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAssetModelCompositeModelFluentBuilder

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

Formats the value using the given formatter.