Interface AssetModelPropertyDefinition.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssetModelPropertyDefinition.Builder,
,AssetModelPropertyDefinition> SdkBuilder<AssetModelPropertyDefinition.Builder,
,AssetModelPropertyDefinition> SdkPojo
- Enclosing class:
AssetModelPropertyDefinition
-
Method Summary
Modifier and TypeMethodDescriptionThe data type of the property definition.dataType
(PropertyDataType dataType) The data type of the property definition.dataTypeSpec
(String dataTypeSpec) The data type of the structure for this property.externalId
(String externalId) An external ID to assign to the property definition.The ID to assign to the asset model property, if desired.The name of the property definition.type
(Consumer<PropertyType.Builder> type) The property definition type (seePropertyType
).type
(PropertyType type) The property definition type (seePropertyType
).The unit of the property definition, such asNewtons
orRPM
.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
-
name
The name of the property definition.
- Parameters:
name
- The name of the property definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataType
The data type of the property definition.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property.- Parameters:
dataType
- The data type of the property definition.If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataType
The data type of the property definition.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property.- Parameters:
dataType
- The data type of the property definition.If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this 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 is required on properties that have the
STRUCT
data type.The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATE
for alarm state in alarm composite models.- Parameters:
dataTypeSpec
- The data type of the structure for this property. This parameter is required on properties that have theSTRUCT
data type.The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATE
for alarm state in alarm composite models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
unit
The unit of the property definition, such as
Newtons
orRPM
.- Parameters:
unit
- The unit of the property definition, such asNewtons
orRPM
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The property definition type (see
PropertyType
). You can only specify one type in a property definition.- Parameters:
type
- The property definition type (seePropertyType
). You can only specify one type in a property definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The property definition type (see
This is a convenience method that creates an instance of thePropertyType
). You can only specify one type in a property definition.PropertyType.Builder
avoiding the need to create one manually viaPropertyType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totype(PropertyType)
.- Parameters:
type
- a consumer that will call methods onPropertyType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
id
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
- Parameters:
id
- The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalId
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Parameters:
externalId
- An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. 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.
-