Class AssetPropertyVariant

java.lang.Object
software.amazon.awssdk.services.iotevents.model.AssetPropertyVariant
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AssetPropertyVariant.Builder,AssetPropertyVariant>
@Generated("software.amazon.awssdk:codegen") public final class AssetPropertyVariant extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AssetPropertyVariant.Builder,AssetPropertyVariant>

A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.

  • For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the doubleValue parameter uses a substitution template.

    '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

For more information, see Expressions in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

See Also:

  • Method Details

    • stringValue

      public final String stringValue()

      The asset property value is a string. You must use an expression, and the evaluated result should be a string.

      Returns:
      The asset property value is a string. You must use an expression, and the evaluated result should be a string.

    • integerValue

      public final String integerValue()

      The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

      Returns:
      The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

    • doubleValue

      public final String doubleValue()

      The asset property value is a double. You must use an expression, and the evaluated result should be a double.

      Returns:
      The asset property value is a double. You must use an expression, and the evaluated result should be a double.

    • booleanValue

      public final String booleanValue()

      The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

      Returns:
      The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

    • toBuilder

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

    • builder

      public static AssetPropertyVariant.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssetPropertyVariant.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.