Interface InfluxDBAction.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InfluxDBAction.Builder,InfluxDBAction>, SdkBuilder<InfluxDBAction.Builder,InfluxDBAction>, SdkPojo
Enclosing class:
InfluxDBAction
@Mutable @NotThreadSafe public static interface InfluxDBAction.Builder extends SdkPojo, CopyableBuilder<InfluxDBAction.Builder,InfluxDBAction>

  • Method Details

    • destinationArn

      InfluxDBAction.Builder destinationArn(String destinationArn)

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

      Parameters:
      destinationArn - The ARN of the InfluxDB topic rule destination that identifies the InfluxDB instance to write to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      InfluxDBAction.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The ARN of the role that grants permission to retrieve the InfluxDB API token from Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      InfluxDBAction.Builder databaseName(String databaseName)

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

      Parameters:
      databaseName - The name of the InfluxDB database to write to. In InfluxDB 2, this is the name of the bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableName

      InfluxDBAction.Builder tableName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • organization

      InfluxDBAction.Builder organization(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      InfluxDBAction.Builder tags(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timestampUnit

      InfluxDBAction.Builder timestampUnit(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timestampUnit

      InfluxDBAction.Builder timestampUnit(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • batchConfig

      InfluxDBAction.Builder batchConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • batchConfig

      default InfluxDBAction.Builder batchConfig(Consumer<InfluxDBBatchConfig.Builder> 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.

      This is a convenience method that creates an instance of the InfluxDBBatchConfig.Builder avoiding the need to create one manually via InfluxDBBatchConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to batchConfig(InfluxDBBatchConfig).

      Parameters:
      batchConfig - a consumer that will call methods on InfluxDBBatchConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: