Interface AssetModelProperty.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssetModelProperty.Builder,
,AssetModelProperty> SdkBuilder<AssetModelProperty.Builder,
,AssetModelProperty> SdkPojo
- Enclosing class:
AssetModelProperty
-
Method Summary
Modifier and TypeMethodDescriptionThe data type of the asset model property.dataType
(PropertyDataType dataType) The data type of the asset model property.dataTypeSpec
(String dataTypeSpec) The data type of the structure for this property.externalId
(String externalId) The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.The ID of the asset model property.The name of the asset model property.The structured path to the property from the root of the asset model.The structured path to the property from the root of the asset model.path
(AssetModelPropertyPathSegment... path) The structured path to the property from the root of the asset model.default AssetModelProperty.Builder
type
(Consumer<PropertyType.Builder> type) The property type (seePropertyType
).type
(PropertyType type) The property type (seePropertyType
).The unit of the asset model property, 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
-
id
The ID of the asset model property.
-
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else
externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
- Parameters:
id
- The ID of the asset model property.-
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else
externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
name
The name of the asset model property.
- Parameters:
name
- The name of the asset model property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataType
The data type of the asset model property.
- Parameters:
dataType
- The data type of the asset model 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 model property.
- Parameters:
dataType
- The data type of the asset model 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 of the asset model property, such as
Newtons
orRPM
.- Parameters:
unit
- The unit of the asset model property, such asNewtons
orRPM
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The property type (see
PropertyType
).- Parameters:
type
- The property type (seePropertyType
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The property type (see
This is a convenience method that creates an instance of thePropertyType
).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:
-
path
The structured path to the property from the root of the asset model.
- Parameters:
path
- The structured path to the property from the root of the asset model.- 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 model.
- Parameters:
path
- The structured path to the property from the root of the asset model.- 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 model.
This is a convenience method that creates an instance of theAssetModelPropertyPathSegment.Builder
avoiding the need to create one manually viaAssetModelPropertyPathSegment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topath(List<AssetModelPropertyPathSegment>)
.- Parameters:
path
- a consumer that will call methods onAssetModelPropertyPathSegment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
externalId
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Parameters:
externalId
- The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. 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.
-