Class AssetProperty
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetProperty.Builder,
AssetProperty>
Contains asset property information.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal 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
).static AssetProperty.Builder
builder()
final PropertyDataType
dataType()
The data type of the asset property.final String
The data type of the asset property.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
The external ID of the asset property.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasPath()
For responses, this returns true if the service returned a value for the Path property.final String
id()
The ID of the asset property.final String
name()
The name of the property.final PropertyNotification
The asset property's notification topic and state.final List
<AssetPropertyPathSegment> path()
The structured path to the property from the root of the asset.static Class
<? extends AssetProperty.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 String
unit()
The unit (such asNewtons
orRPM
) of the asset property.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the asset property.
- Returns:
- The ID of the asset property.
-
name
The name of the property.
- Returns:
- The name of the property.
-
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:
- 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.
-
notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
- Returns:
- The asset property's notification topic and state. For more information, see UpdateAssetProperty.
-
dataType
The data type of the asset 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 asset property.
- See Also:
-
dataTypeAsString
The data type of the asset 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 asset property.
- See Also:
-
dataTypeSpec
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.- Returns:
- The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.
-
unit
The unit (such as
Newtons
orRPM
) of the asset property.- Returns:
- The unit (such as
Newtons
orRPM
) of the asset property.
-
hasPath
public final boolean hasPath()For responses, this returns true if the service returned a value for the Path property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
path
The structured path to the property from the root of the asset.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPath()
method.- Returns:
- The structured path to the property from the root of the asset.
-
externalId
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Returns:
- The external ID of the asset property. 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<AssetProperty.Builder,
AssetProperty> - 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
-