Package software.amazon.awssdk.services.iot.model

Class TimestreamAction

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

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

See Also:

  • Method Details

    • roleArn

      public final String roleArn()

      The ARN of the role that grants permission to write to the Amazon Timestream database table.

      Returns:
      The ARN of the role that grants permission to write to the Amazon Timestream database table.

    • databaseName

      public final String databaseName()

      The name of an Amazon Timestream database.

      Returns:
      The name of an Amazon Timestream database.

    • tableName

      public final String tableName()

      The name of the database table into which to write the measure records.

      Returns:
      The name of the database table into which to write the measure records.

    • hasDimensions

      public final boolean hasDimensions()
      For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • dimensions

      public final List<TimestreamDimension> dimensions()

      Metadata attributes of the time series that are written in each measure record.

      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 hasDimensions() method.

      Returns:
      Metadata attributes of the time series that are written in each measure record.

    • timestamp

      public final TimestreamTimestamp timestamp()

      Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

      You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

      If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

      Returns:
      Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

      You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

      If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

    • toBuilder

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

    • builder

      public static TimestreamAction.Builder builder()

    • serializableBuilderClass

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