Class InfluxDBBatchConfig

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

The batching configuration of an InfluxDB rule action. IoT closes a batch and writes it to InfluxDB when the first of the configured limits is reached.

See Also:

  • Method Details

    • maxBatchSize

      public final Integer maxBatchSize()

      The maximum number of data points to collect in a batch.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

      Returns:
      The maximum number of data points to collect in a batch.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

    • maxBatchOpenMs

      public final Integer maxBatchOpenMs()

      The maximum length of time, in milliseconds, to keep a batch open before writing it to InfluxDB.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

      Returns:
      The maximum length of time, in milliseconds, to keep a batch open before writing it to InfluxDB.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

    • maxBatchSizeBytes

      public final Integer maxBatchSizeBytes()

      The maximum size of a batch, in bytes, before IoT writes it to InfluxDB.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

      Returns:
      The maximum size of a batch, in bytes, before IoT writes it to InfluxDB.

      If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

    • batchAcrossTopics

      public final Boolean batchAcrossTopics()

      Specifies whether to collect data points from different topics into the same batch.

      If omitted or false, IoT batches data points for each topic separately.

      Returns:
      Specifies whether to collect data points from different topics into the same batch.

      If omitted or false, IoT batches data points for each topic separately.

    • toBuilder

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

    • builder

      public static InfluxDBBatchConfig.Builder builder()

    • serializableBuilderClass

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