Interface AssetProperty.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AssetProperty.Builder,AssetProperty>, SdkBuilder<AssetProperty.Builder,AssetProperty>, SdkPojo

Enclosing class:

AssetProperty

@Mutable
@NotThreadSafe
public static interface AssetProperty.Builder
extends SdkPojo, CopyableBuilder<AssetProperty.Builder,AssetProperty>

Method Summary

Modifier and Type	Method	Description
AssetProperty.Builder	alias(String alias)	The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature).
AssetProperty.Builder	dataType(String dataType)	The data type of the asset property.
AssetProperty.Builder	dataType(PropertyDataType dataType)	The data type of the asset property.
AssetProperty.Builder	dataTypeSpec(String dataTypeSpec)	The data type of the structure for this property.
AssetProperty.Builder	externalId(String externalId)	The external ID of the asset property.
AssetProperty.Builder	id(String id)	The ID of the asset property.
AssetProperty.Builder	name(String name)	The name of the property.
default AssetProperty.Builder	notification(Consumer<PropertyNotification.Builder> notification)	The asset property's notification topic and state.
AssetProperty.Builder	notification(PropertyNotification notification)	The asset property's notification topic and state.
AssetProperty.Builder	path(Collection<AssetPropertyPathSegment> path)	The structured path to the property from the root of the asset.
AssetProperty.Builder	path(Consumer<AssetPropertyPathSegment.Builder>... path)	The structured path to the property from the root of the asset.
AssetProperty.Builder	path(AssetPropertyPathSegment... path)	The structured path to the property from the root of the asset.
AssetProperty.Builder	unit(String unit)	The unit (such as Newtons or RPM) of the asset property.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

AssetProperty.Builder id(String id)

The ID of the asset property.

Parameters:

id - The ID of the asset property.

Returns:

Returns a reference to this object so that method calls can be chained together.

externalId

AssetProperty.Builder externalId(String externalId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

name

AssetProperty.Builder name(String name)

The name of the property.

Parameters:

name - The name of the property.

Returns:

Returns a reference to this object so that method calls can be chained together.

alias

AssetProperty.Builder alias(String 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 IoT SiteWise User Guide.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

notification

AssetProperty.Builder notification(PropertyNotification notification)

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

Parameters:

notification - The asset property's notification topic and state. For more information, see UpdateAssetProperty.

Returns:

Returns a reference to this object so that method calls can be chained together.

notification

default AssetProperty.Builder notification(Consumer<PropertyNotification.Builder> notification)

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

This is a convenience method that creates an instance of the PropertyNotification.Builder avoiding the need to create one manually via PropertyNotification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notification(PropertyNotification).

Parameters:

notification - a consumer that will call methods on PropertyNotification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• notification(PropertyNotification)

dataType

AssetProperty.Builder dataType(String dataType)

The data type of the asset property.

Parameters:

dataType - The data type of the asset property.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PropertyDataType
• PropertyDataType

dataType

AssetProperty.Builder dataType(PropertyDataType dataType)

The data type of the asset property.

Parameters:

dataType - The data type of the asset property.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PropertyDataType
• PropertyDataType

dataTypeSpec

AssetProperty.Builder dataTypeSpec(String dataTypeSpec)

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

Parameters:

dataTypeSpec - The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

AssetProperty.Builder unit(String unit)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

path

AssetProperty.Builder path(Collection<AssetPropertyPathSegment> path)

The structured path to the property from the root of the asset.

Parameters:

path - The structured path to the property from the root of the asset.

Returns:

Returns a reference to this object so that method calls can be chained together.

path

AssetProperty.Builder path(AssetPropertyPathSegment... path)

The structured path to the property from the root of the asset.

Parameters:

path - The structured path to the property from the root of the asset.

Returns:

Returns a reference to this object so that method calls can be chained together.

path

AssetProperty.Builder path(Consumer<AssetPropertyPathSegment.Builder>... path)

The structured path to the property from the root of the asset.

This is a convenience method that creates an instance of the AssetPropertyPathSegment.Builder avoiding the need to create one manually via AssetPropertyPathSegment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to path(List<AssetPropertyPathSegment>).

Parameters:

path - a consumer that will call methods on AssetPropertyPathSegment.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• path(java.util.Collection<AssetPropertyPathSegment>)