Class AssetModelProperty
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetModelProperty.Builder,
AssetModelProperty>
Contains information about an asset model property.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AssetModelProperty.Builder
builder()
final PropertyDataType
dataType()
The data type of the asset model property.final String
The data type of the asset model 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 (if any) provided in the CreateAssetModel or UpdateAssetModel operation.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 model property.final String
name()
The name of the asset model property.path()
The structured path to the property from the root of the asset model.static Class
<? extends AssetModelProperty.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 type (seePropertyType
).final String
unit()
The unit of the asset model property, such asNewtons
orRPM
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.
- Returns:
- 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.
-
-
-
name
The name of the asset model property.
- Returns:
- The name of the asset model property.
-
dataType
The data type of the asset model 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 model property.
- See Also:
-
dataTypeAsString
The data type of the asset model 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 model 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 of the asset model property, such as
Newtons
orRPM
.- Returns:
- The unit of the asset model property, such as
Newtons
orRPM
.
-
type
The property type (see
PropertyType
).- Returns:
- The property type (see
PropertyType
).
-
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 model.
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 model.
-
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:
- 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.
-
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<AssetModelProperty.Builder,
AssetModelProperty> - 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
-