Class ThresholdBatcher<E> (2.59.0)

public final class ThresholdBatcher<E>

Queues up elements until either a duration of time has passed or any threshold in a given set of thresholds is breached, and then delivers the elements in a batch to the consumer.

Inheritance

java.lang.Object > ThresholdBatcher<E>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
`E`

Static Methods

<E>newBuilder()

public static ThresholdBatcher.Builder<E> <E>newBuilder()

Get a new builder for a ThresholdBatcher.

Returns
Type	Description
`Builder<E>`

Methods

add(E e)

public void add(E e)

Adds an element to the batcher. If the element causes the collection to go past any of the thresholds, the batch will be sent to the ThresholdBatchReceiver.

Parameter
Name	Description
`e`	`E`

Exceptions
Type	Description
`FlowController.FlowControlException`

pushCurrentBatch()

public ApiFuture<Void> pushCurrentBatch()

Push the current batch to the batch receiver. Returns an ApiFuture that completes once the batch has been processed by the batch receiver and the flow controller resources have been released.

Note that this future can complete for the current batch before previous batches have completed, so it cannot be depended upon for flushing.

Returns
Type	Description
`ApiFuture<Void>`