Package software.amazon.awscdk.services.iotsitewise

Class CfnAssetModel.AssetModelHierarchyProperty.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnAssetModel.AssetModelHierarchyProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAssetModel.AssetModelHierarchyProperty>

Enclosing interface:

CfnAssetModel.AssetModelHierarchyProperty

@Stability(Stable)
public static final class CfnAssetModel.AssetModelHierarchyProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAssetModel.AssetModelHierarchyProperty>

A builder for CfnAssetModel.AssetModelHierarchyProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAssetModel.AssetModelHierarchyProperty	build()	Builds the configured instance.
CfnAssetModel.AssetModelHierarchyProperty.Builder	childAssetModelId(String childAssetModelId)	Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getChildAssetModelId()
CfnAssetModel.AssetModelHierarchyProperty.Builder	externalId(String externalId)	Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getExternalId()
CfnAssetModel.AssetModelHierarchyProperty.Builder	id(String id)	Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getId()
CfnAssetModel.AssetModelHierarchyProperty.Builder	logicalId(String logicalId)	Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getLogicalId()
CfnAssetModel.AssetModelHierarchyProperty.Builder	name(String name)	Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

childAssetModelId

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty.Builder childAssetModelId(String childAssetModelId)

Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getChildAssetModelId()

Parameters:

childAssetModelId - The ID of the asset model, in UUID format. This parameter is required. All assets in this hierarchy must be instances of the childAssetModelId asset model. AWS 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 AWS IoT SiteWise User Guide .

Returns:

this

name

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty.Builder name(String name)

Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getName()

Parameters:

name - The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation. This parameter is required.

Returns:

this

externalId

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty.Builder externalId(String externalId)

Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getExternalId()

Parameters:

externalId - 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 AWS IoT SiteWise User Guide .

One of ExternalId or LogicalId must be specified.

Returns:

this

id

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty.Builder id(String id)

Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getId()

Parameters:

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

This is a return value and can't be set.

• If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. AWS 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 AWS IoT SiteWise User Guide .

Returns:

this

logicalId

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty.Builder logicalId(String logicalId)

Sets the value of CfnAssetModel.AssetModelHierarchyProperty.getLogicalId()

Parameters:

logicalId - The LogicalID of the asset model hierarchy. This ID is a hierarchyLogicalId .

One of ExternalId or LogicalId must be specified.

Returns:

this

build

@Stability(Stable)
public CfnAssetModel.AssetModelHierarchyProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAssetModel.AssetModelHierarchyProperty>

Returns:

a new instance of CfnAssetModel.AssetModelHierarchyProperty

Throws:

NullPointerException - if any required attribute was not provided