Package software.amazon.awscdk.services.iotsitewise

Class CfnAssetModel.VariableValueProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnAssetModel.VariableValueProperty

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

A builder for CfnAssetModel.VariableValueProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAssetModel.VariableValueProperty	build()	Builds the configured instance.
CfnAssetModel.VariableValueProperty.Builder	hierarchyExternalId(String hierarchyExternalId)	Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyExternalId()
CfnAssetModel.VariableValueProperty.Builder	hierarchyId(String hierarchyId)	Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyId()
CfnAssetModel.VariableValueProperty.Builder	hierarchyLogicalId(String hierarchyLogicalId)	Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyLogicalId()
CfnAssetModel.VariableValueProperty.Builder	propertyExternalId(String propertyExternalId)	Sets the value of CfnAssetModel.VariableValueProperty.getPropertyExternalId()
CfnAssetModel.VariableValueProperty.Builder	propertyId(String propertyId)	Sets the value of CfnAssetModel.VariableValueProperty.getPropertyId()
CfnAssetModel.VariableValueProperty.Builder	propertyLogicalId(String propertyLogicalId)	Sets the value of CfnAssetModel.VariableValueProperty.getPropertyLogicalId()
CfnAssetModel.VariableValueProperty.Builder	propertyPath(List<? extends Object> propertyPath)	Sets the value of CfnAssetModel.VariableValueProperty.getPropertyPath()
CfnAssetModel.VariableValueProperty.Builder	propertyPath(IResolvable propertyPath)	Sets the value of CfnAssetModel.VariableValueProperty.getPropertyPath()

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

hierarchyExternalId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder hierarchyExternalId(String hierarchyExternalId)

Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyExternalId()

Parameters:

hierarchyExternalId - The external ID of the hierarchy being referenced. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

Returns:

this

hierarchyId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder hierarchyId(String hierarchyId)

Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyId()

Parameters:

hierarchyId - The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

Returns:

this

hierarchyLogicalId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder hierarchyLogicalId(String hierarchyLogicalId)

Sets the value of CfnAssetModel.VariableValueProperty.getHierarchyLogicalId()

Parameters:

hierarchyLogicalId - The LogicalID of the hierarchy to query for the PropertyLogicalID . You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

Returns:

this

propertyExternalId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder propertyExternalId(String propertyExternalId)

Sets the value of CfnAssetModel.VariableValueProperty.getPropertyExternalId()

Parameters:

propertyExternalId - The external ID of the property being referenced. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

Returns:

this

propertyId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder propertyId(String propertyId)

Sets the value of CfnAssetModel.VariableValueProperty.getPropertyId()

Parameters:

propertyId - The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

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

Returns:

this

propertyLogicalId

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder propertyLogicalId(String propertyLogicalId)

Sets the value of CfnAssetModel.VariableValueProperty.getPropertyLogicalId()

Parameters:

propertyLogicalId - The LogicalID of the property that is being referenced.

Returns:

this

propertyPath

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder propertyPath(IResolvable propertyPath)

Sets the value of CfnAssetModel.VariableValueProperty.getPropertyPath()

Parameters:

propertyPath - The path of the property. Each step of the path is the name of the step. See the following example:

PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite

Returns:

this

propertyPath

@Stability(Stable)
public CfnAssetModel.VariableValueProperty.Builder propertyPath(List<? extends Object> propertyPath)

Sets the value of CfnAssetModel.VariableValueProperty.getPropertyPath()

Parameters:

propertyPath - The path of the property. Each step of the path is the name of the step. See the following example:

PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAssetModel.VariableValueProperty

Throws:

NullPointerException - if any required attribute was not provided