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:

  • Method Details

    • 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.

    • 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:

    • 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:

    • 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.

    • toBuilder

      public AssetModelPropertyDefinition.Builder 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 interface ToCopyableBuilder<AssetModelPropertyDefinition.Builder,AssetModelPropertyDefinition>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.