Class AssetModelPropertyDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetModelPropertyDefinition.Builder,
AssetModelPropertyDefinition>
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final PropertyDataType
dataType()
The data type of the property definition.final String
The data type of the property definition.final String
The data type of the structure for this property.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
An external ID to assign to the property definition.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The ID to assign to the asset model property, if desired.final String
name()
The name of the property definition.static Class
<? extends AssetModelPropertyDefinition.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final PropertyType
type()
The property definition type (seePropertyType
).final String
unit()
The unit of the property definition, such asNewtons
orRPM
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the property definition.
- Returns:
- The name of the property definition.
-
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.If the service returns an enum value that is not available in the current SDK version,
dataType
will returnPropertyDataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataTypeAsString()
.- Returns:
- 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. - See Also:
-
dataTypeAsString
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.If the service returns an enum value that is not available in the current SDK version,
dataType
will returnPropertyDataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataTypeAsString()
.- Returns:
- 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. - 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.- Returns:
- 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.
-
unit
The unit of the property definition, such as
Newtons
orRPM
.- Returns:
- The unit of the property definition, such as
Newtons
orRPM
.
-
type
The property definition type (see
PropertyType
). You can only specify one type in a property definition.- Returns:
- The property definition type (see
PropertyType
). You can only specify one type in a property definition.
-
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:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssetModelPropertyDefinition.Builder,
AssetModelPropertyDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-