Interface Property.Builder

All Superinterfaces:

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

Enclosing class:

Property

public static interface Property.Builder
extends SdkPojo, CopyableBuilder<Property.Builder,Property>

Method Summary

Modifier and Type	Method	Description
Property.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).
Property.Builder	dataType(String dataType)	The property data type.
Property.Builder	dataType(PropertyDataType dataType)	The property data type.
Property.Builder	externalId(String externalId)	The external ID of the asset property.
Property.Builder	id(String id)	The ID of the asset property.
Property.Builder	name(String name)	The name of the property.
default Property.Builder	notification(Consumer<PropertyNotification.Builder> notification)	The asset property's notification topic and state.
Property.Builder	notification(PropertyNotification notification)	The asset property's notification topic and state.
Property.Builder	path(Collection<AssetPropertyPathSegment> path)	The structured path to the property from the root of the asset.
Property.Builder	path(Consumer<AssetPropertyPathSegment.Builder>... path)	The structured path to the property from the root of the asset.
Property.Builder	path(AssetPropertyPathSegment... path)	The structured path to the property from the root of the asset.
default Property.Builder	type(Consumer<PropertyType.Builder> type)	The property type (see PropertyType).
Property.Builder	type(PropertyType type)	The property type (see PropertyType).
Property.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, sdkFields

Method Details

id

Property.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.

name

Property.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

Property.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

Property.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 Property.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

Property.Builder dataType(String dataType)

The property data type.

Parameters:

dataType - The property data type.

Returns:

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

See Also:

• PropertyDataType
• PropertyDataType

dataType

Property.Builder dataType(PropertyDataType dataType)

The property data type.

Parameters:

dataType - The property data type.

Returns:

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

See Also:

• PropertyDataType
• PropertyDataType

unit

Property.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.

type

Property.Builder type(PropertyType type)

The property type (see PropertyType). A property contains one type.

Parameters:

type - The property type (see PropertyType). A property contains one type.

Returns:

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

type

default Property.Builder type(Consumer<PropertyType.Builder> type)

The property type (see PropertyType). A property contains one type.

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

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

Parameters:

type - a consumer that will call methods on PropertyType.Builder

Returns:

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

See Also:

• type(PropertyType)

path

Property.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

Property.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

Property.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>)

externalId

Property.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.