Interface AssetProperty.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssetProperty.Builder,
,AssetProperty> SdkBuilder<AssetProperty.Builder,
,AssetProperty> SdkPojo
- Enclosing class:
AssetProperty
-
Method Summary
Modifier and TypeMethodDescriptionThe alias that identifies the property, such as an OPC-UA server data stream path (for example,/company/windfarm/3/turbine/7/temperature
).The data type of the asset property.dataType
(PropertyDataType dataType) The data type of the asset property.dataTypeSpec
(String dataTypeSpec) The data type of the structure for this property.externalId
(String externalId) The external ID of the asset property.The ID of the asset property.The name of the property.default AssetProperty.Builder
notification
(Consumer<PropertyNotification.Builder> notification) The asset property's notification topic and state.notification
(PropertyNotification notification) The asset property's notification topic and state.The structured path to the property from the root of the asset.path
(Consumer<AssetPropertyPathSegment.Builder>... path) The structured path to the property from the root of the asset.path
(AssetPropertyPathSegment... path) The structured path to the property from the root of the asset.The unit (such asNewtons
orRPM
) 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
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
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
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
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
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
This is a convenience method that creates an instance of thePropertyNotification.Builder
avoiding the need to create one manually viaPropertyNotification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotification(PropertyNotification)
.- Parameters:
notification
- a consumer that will call methods onPropertyNotification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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 theSTRUCT
data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
unit
The unit (such as
Newtons
orRPM
) of the asset property.- Parameters:
unit
- The unit (such asNewtons
orRPM
) of the asset property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
The structured path to the property from the root of the asset.
This is a convenience method that creates an instance of theAssetPropertyPathSegment.Builder
avoiding the need to create one manually viaAssetPropertyPathSegment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topath(List<AssetPropertyPathSegment>)
.- Parameters:
path
- a consumer that will call methods onAssetPropertyPathSegment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-