Package software.amazon.awssdk.services.iotsitewise.model

Class AssetModelPropertyDefinition

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.AssetModelPropertyDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssetModelPropertyDefinition.Builder,AssetModelPropertyDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class AssetModelPropertyDefinition
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetModelPropertyDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static AssetModelPropertyDefinition.Builder	builder()
PropertyDataType	dataType()	The data type of the property definition.
String	dataTypeAsString()	The data type of the property definition.
String	dataTypeSpec()	The data type of the structure for this property.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	An external ID to assign to the property definition.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID to assign to the asset model property, if desired.
String	name()	The name of the property definition.
List<SdkField<?>>	sdkFields()
static Class<? extends AssetModelPropertyDefinition.Builder>	serializableBuilderClass()
AssetModelPropertyDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PropertyType	type()	The property definition type (see PropertyType).
String	unit()	The unit of the property definition, such as Newtons or RPM.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the property definition.

Returns:

The name of the property definition.

dataType

public final PropertyDataType dataType()

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec 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 return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

See Also:

PropertyDataType

dataTypeAsString

public final String dataTypeAsString()

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec 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 return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

See Also:

PropertyDataType

dataTypeSpec

public final String 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

public final String unit()

The unit of the property definition, such as Newtons or RPM.

Returns:

The unit of the property definition, such as Newtons or RPM.

type

public final PropertyType 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

public final String 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

public final String 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

public AssetModelPropertyDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetModelPropertyDefinition.Builder,AssetModelPropertyDefinition>

builder

public static AssetModelPropertyDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends AssetModelPropertyDefinition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo