Interface BatchConfig.Builder

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

  • Method Details

    • maxBatchOpenMs

      BatchConfig.Builder maxBatchOpenMs(Integer maxBatchOpenMs)

      The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.

      Parameters:
      maxBatchOpenMs - The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxBatchSize

      BatchConfig.Builder maxBatchSize(Integer maxBatchSize)

      The maximum number of messages that are batched together in a single action execution.

      Parameters:
      maxBatchSize - The maximum number of messages that are batched together in a single action execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxBatchSizeBytes

      BatchConfig.Builder maxBatchSizeBytes(Integer maxBatchSizeBytes)

      Maximum size of a message batch, in bytes.

      Parameters:
      maxBatchSizeBytes - Maximum size of a message batch, in bytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • batchAcrossTopics

      BatchConfig.Builder batchAcrossTopics(Boolean batchAcrossTopics)

      Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false.

      When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic.

      Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the batchAcrossTopics setting.

      Parameters:
      batchAcrossTopics - Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false.

      When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic.

      Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the batchAcrossTopics setting.

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