Package software.amazon.awscdk.services.iotsitewise

Class CfnAsset.AssetPropertyProperty.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnAsset.AssetPropertyProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAsset.AssetPropertyProperty>

Enclosing interface:

CfnAsset.AssetPropertyProperty

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

A builder for CfnAsset.AssetPropertyProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAsset.AssetPropertyProperty.Builder	alias(String alias)	Sets the value of CfnAsset.AssetPropertyProperty.getAlias()
CfnAsset.AssetPropertyProperty	build()	Builds the configured instance.
CfnAsset.AssetPropertyProperty.Builder	externalId(String externalId)	Sets the value of CfnAsset.AssetPropertyProperty.getExternalId()
CfnAsset.AssetPropertyProperty.Builder	id(String id)	Sets the value of CfnAsset.AssetPropertyProperty.getId()
CfnAsset.AssetPropertyProperty.Builder	logicalId(String logicalId)	Sets the value of CfnAsset.AssetPropertyProperty.getLogicalId()
CfnAsset.AssetPropertyProperty.Builder	notificationState(String notificationState)	Sets the value of CfnAsset.AssetPropertyProperty.getNotificationState()
CfnAsset.AssetPropertyProperty.Builder	unit(String unit)	Sets the value of CfnAsset.AssetPropertyProperty.getUnit()

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

alias

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder alias(String alias)

Sets the value of CfnAsset.AssetPropertyProperty.getAlias()

Parameters:

alias - The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

Returns:

this

externalId

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder externalId(String externalId)

Sets the value of CfnAsset.AssetPropertyProperty.getExternalId()

Parameters:

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

Returns:

this

id

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder id(String id)

Sets the value of CfnAsset.AssetPropertyProperty.getId()

Parameters:

id - The ID of the asset property.

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

Returns:

this

logicalId

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder logicalId(String logicalId)

Sets the value of CfnAsset.AssetPropertyProperty.getLogicalId()

Parameters:

logicalId - The LogicalID of the asset property.

Returns:

this

notificationState

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder notificationState(String notificationState)

Sets the value of CfnAsset.AssetPropertyProperty.getNotificationState()

Parameters:

notificationState - The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide .

If you omit this parameter, the notification state is set to DISABLED .

Returns:

this

unit

@Stability(Stable)
public CfnAsset.AssetPropertyProperty.Builder unit(String unit)

Sets the value of CfnAsset.AssetPropertyProperty.getUnit()

Parameters:

unit - The unit (such as Newtons or RPM ) of the asset property.

Returns:

this

build

@Stability(Stable)
public CfnAsset.AssetPropertyProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAsset.AssetPropertyProperty>

Returns:

a new instance of CfnAsset.AssetPropertyProperty

Throws:

NullPointerException - if any required attribute was not provided