Class InfluxDBAction

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

The InfluxDB rule action converts the message payload into InfluxDB line protocol. It writes the result to a table in an InfluxDB database. The database can be an Amazon Timestream for InfluxDB instance or a self-managed InfluxDB cluster.

The action connects to InfluxDB through an InfluxDB topic rule destination, which must be in the ENABLED state before the action can write data.

See Also:

  • Method Details

    • destinationArn

      public final String destinationArn()

      The ARN of the InfluxDB topic rule destination that identifies the InfluxDB instance to write to.

      Returns:
      The ARN of the InfluxDB topic rule destination that identifies the InfluxDB instance to write to.

    • roleArn

      public final String roleArn()

      The ARN of the role that grants permission to retrieve the InfluxDB API token from Amazon Web Services Secrets Manager.

      Returns:
      The ARN of the role that grants permission to retrieve the InfluxDB API token from Amazon Web Services Secrets Manager.

    • databaseName

      public final String databaseName()

      The name of the InfluxDB database to write to. In InfluxDB 2, this is the name of the bucket.

      Returns:
      The name of the InfluxDB database to write to. In InfluxDB 2, this is the name of the bucket.

    • tableName

      public final String tableName()

      The name of the table to write the data point to. This is the measurement name of the InfluxDB line protocol record.

      Accepts substitution templates.

      Returns:
      The name of the table to write the data point to. This is the measurement name of the InfluxDB line protocol record.

      Accepts substitution templates.

    • organization

      public final String organization()

      The name of the InfluxDB organization that owns the database.

      A write to an InfluxDB 2 instance fails if this value isn't set. This value isn't used when the destination is an InfluxDB 3 instance.

      Returns:
      The name of the InfluxDB organization that owns the database.

      A write to an InfluxDB 2 instance fails if this value isn't set. This value isn't used when the destination is an InfluxDB 3 instance.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The set of tags to write with each data point. Tags are the indexed metadata of an InfluxDB data point.

      Tag names and tag values accept substitution templates. A tag name can't use the @{...} per-element form. A tag name must resolve to the same value for every element of an array payload.

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

      Returns:
      The set of tags to write with each data point. Tags are the indexed metadata of an InfluxDB data point.

      Tag names and tag values accept substitution templates. A tag name can't use the @{...} per-element form. A tag name must resolve to the same value for every element of an array payload.

    • timestampUnit

      public final InfluxDBTimestampUnit timestampUnit()

      The precision of the timestamp written with each data point. Valid values are s (seconds), ms (milliseconds), us (microseconds), and ns (nanoseconds).

      If omitted, the topic rule action uses ms.

      If the service returns an enum value that is not available in the current SDK version, timestampUnit will return InfluxDBTimestampUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timestampUnitAsString().

      Returns:
      The precision of the timestamp written with each data point. Valid values are s (seconds), ms (milliseconds), us (microseconds), and ns (nanoseconds).

      If omitted, the topic rule action uses ms.

      See Also:

    • timestampUnitAsString

      public final String timestampUnitAsString()

      The precision of the timestamp written with each data point. Valid values are s (seconds), ms (milliseconds), us (microseconds), and ns (nanoseconds).

      If omitted, the topic rule action uses ms.

      If the service returns an enum value that is not available in the current SDK version, timestampUnit will return InfluxDBTimestampUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timestampUnitAsString().

      Returns:
      The precision of the timestamp written with each data point. Valid values are s (seconds), ms (milliseconds), us (microseconds), and ns (nanoseconds).

      If omitted, the topic rule action uses ms.

      See Also:

    • batchConfig

      public final InfluxDBBatchConfig batchConfig()

      The batching configuration for the action. When present, IoT collects data points from multiple messages and writes them to InfluxDB in a single request.

      If omitted, each message is written to InfluxDB in its own request.

      Returns:
      The batching configuration for the action. When present, IoT collects data points from multiple messages and writes them to InfluxDB in a single request.

      If omitted, each message is written to InfluxDB in its own request.

    • toBuilder

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

    • builder

      public static InfluxDBAction.Builder builder()

    • serializableBuilderClass

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