org.apache.samza.table.batching

Interface Batch<K,V,U>

Type Parameters:

K - The type of the key associated with the Operation

V - The type of the value associated with the Operation

U - The type of the update associated with the Operation

public interface Batch<K,V,U>

Manages a sequence of Operations, which will be performed as a batch. A batch can be configured with a maxBatchSize and/or maxBatchDelay. When the number of operations in the batch exceeds the maxBatchSize or the time window exceeds the maxBatchDelay, the batch will be performed.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Void>	addOperation(Operation<K,V,U> operation) Add an operation to the batch.
void	close() Close the bach so that it will not accept more operations.
void	complete() Change the batch status to be complete.
void	completeExceptionally(java.lang.Throwable throwable) Change the batch status to be complete with exception.
java.time.Duration	getMaxBatchDelay()
int	getMaxBatchSize()
java.util.Collection<Operation<K,V,U>>	getOperations()
boolean	isClosed()
default boolean	isEmpty()
int	size()

Method Detail

addOperation

java.util.concurrent.CompletableFuture<java.lang.Void> addOperation(Operation<K,V,U> operation)

Add an operation to the batch.

Parameters:

operation - The operation to be added.

Returns:

A CompletableFuture that indicate the status of the batch.

close

void close()

Close the bach so that it will not accept more operations.

isClosed

boolean isClosed()

Returns:

Whether the bach can accept more operations.

getOperations

java.util.Collection<Operation<K,V,U>> getOperations()

Returns:

The operations buffered by the batch.

getMaxBatchDelay

java.time.Duration getMaxBatchDelay()

Returns:

The batch max delay.

getMaxBatchSize

int getMaxBatchSize()

Returns:

The batch capacity

complete

void complete()

Change the batch status to be complete.

completeExceptionally

void completeExceptionally(java.lang.Throwable throwable)

Change the batch status to be complete with exception.

size

int size()

Returns:

The number of operations in the batch.

isEmpty

default boolean isEmpty()

Returns:

True if the batch is empty.