Package software.amazon.awssdk.services.iotevents.model

Class IotSiteWiseAction

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

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

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

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

  • 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 propertyAlias parameter uses a substitution template.

    'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

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

See Also:

  • Method Details

    • entryId

      public final String entryId()

      A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

      Returns:
      A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

    • assetId

      public final String assetId()

      The ID of the asset that has the specified property.

      Returns:
      The ID of the asset that has the specified property.

    • propertyId

      public final String propertyId()

      The ID of the asset property.

      Returns:
      The ID of the asset property.

    • propertyAlias

      public final String propertyAlias()

      The alias of the asset property.

      Returns:
      The alias of the asset property.

    • propertyValue

      public final AssetPropertyValue propertyValue()

      The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

      Returns:
      The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

    • toBuilder

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

    • builder

      public static IotSiteWiseAction.Builder builder()

    • serializableBuilderClass

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