Interface AssetPropertySummary.Builder

All Superinterfaces:

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

Enclosing class:

AssetPropertySummary

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

Method Summary

Modifier and Type	Method	Description
AssetPropertySummary.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).
AssetPropertySummary.Builder	assetCompositeModelId(String assetCompositeModelId)	The ID of the composite model that contains the asset property.
AssetPropertySummary.Builder	externalId(String externalId)	The external ID of the property.
AssetPropertySummary.Builder	id(String id)	The ID of the property.
default AssetPropertySummary.Builder	notification(Consumer<PropertyNotification.Builder> notification)	Sets the value of the Notification property for this object.
AssetPropertySummary.Builder	notification(PropertyNotification notification)	Sets the value of the Notification property for this object.
AssetPropertySummary.Builder	path(Collection<AssetPropertyPathSegment> path)	The structured path to the property from the root of the asset.
AssetPropertySummary.Builder	path(Consumer<AssetPropertyPathSegment.Builder>... path)	The structured path to the property from the root of the asset.
AssetPropertySummary.Builder	path(AssetPropertyPathSegment... path)	The structured path to the property from the root of the asset.
AssetPropertySummary.Builder	unit(String unit)	The unit of measure (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

AssetPropertySummary.Builder id(String id)

The ID of the property.

Parameters:

id - The ID of the property.

Returns:

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

alias

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

unit

AssetPropertySummary.Builder unit(String unit)

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

Parameters:

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

Returns:

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

notification

AssetPropertySummary.Builder notification(PropertyNotification notification)

Sets the value of the Notification property for this object.

Parameters:

notification - The new value for the Notification property for this object.

Returns:

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

notification

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

Sets the value of the Notification property for this object. 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)

assetCompositeModelId

AssetPropertySummary.Builder assetCompositeModelId(String assetCompositeModelId)

The ID of the composite model that contains the asset property.

Parameters:

assetCompositeModelId - The ID of the composite model that contains the asset property.

Returns:

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

path

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

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

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

AssetPropertySummary.Builder externalId(String externalId)

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

Parameters:

externalId - The external ID of the 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.