Interface BatchConfiguration.Builder

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

  • Method Details

    • maxBatchSize

      BatchConfiguration.Builder maxBatchSize(Integer maxBatchSize)

      The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read.

      Parameters:
      maxBatchSize - The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxBatchWindowInSeconds

      BatchConfiguration.Builder maxBatchWindowInSeconds(Integer maxBatchWindowInSeconds)

      The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read.

      Parameters:
      maxBatchWindowInSeconds - The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read.
      Returns:
      Returns a reference to this object so that method calls can be chained together.