Package com.google.api.gax.batching

Class BatcherImpl<ElementT,ElementResultT,RequestT,ResponseT>

java.lang.Object

com.google.api.gax.batching.BatcherImpl<ElementT,ElementResultT,RequestT,ResponseT>

Type Parameters:

ElementT - The type of each individual element to be batched.

ElementResultT - The type of the result for each individual element.

RequestT - The type of the request that will contain the accumulated elements.

ResponseT - The type of the response that will unpack into individual element results.

All Implemented Interfaces:

Batcher<ElementT,ElementResultT>, AutoCloseable

@InternalApi("For google-cloud-java client use only")
public class BatcherImpl<ElementT,ElementResultT,RequestT,ResponseT>
extends Object
implements Batcher<ElementT,ElementResultT>

Queues up the elements until flush() is called; once batching is over, returned future resolves.

This class is not thread-safe, and expects to be used from a single thread.

Field Summary

Fields inherited from interface com.google.api.gax.batching.Batcher

THROTTLED_TIME_KEY

Constructor Summary

Constructors

Constructor	Description
BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor, UnaryCallable<RequestT,ResponseT> unaryCallable, RequestT prototype, BatchingSettings batchingSettings, ScheduledExecutorService executor)	Deprecated. Please instantiate the Batcher with FlowController and ApiCallContext
BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor, UnaryCallable<RequestT,ResponseT> unaryCallable, RequestT prototype, BatchingSettings batchingSettings, ScheduledExecutorService executor, FlowController flowController)	Deprecated. Please instantiate the Batcher with ApiCallContext
BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor, UnaryCallable<RequestT,ResponseT> unaryCallable, RequestT prototype, BatchingSettings batchingSettings, ScheduledExecutorService executor, FlowController flowController, ApiCallContext callContext)

Method Summary

Modifier and Type	Method	Description
ApiFuture<ElementResultT>	add(ElementT element)	Queues the passed in element to be sent at some point in the future.
void	close()	Closes this Batcher by preventing new elements from being added, and then flushing the existing elements.
ApiFuture<Void>	closeAsync()	Closes this Batcher by preventing new elements from being added, and then sending outstanding elements.
void	flush()	Synchronously sends any pending elements as a batch and waits for all outstanding batches to be complete.
FlowController	getFlowController()
void	sendOutstanding()	Sends accumulated elements asynchronously for batching.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BatcherImpl

@Deprecated
public BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor,
 UnaryCallable<RequestT,ResponseT> unaryCallable,
 RequestT prototype,
 BatchingSettings batchingSettings,
 ScheduledExecutorService executor)

Deprecated.

Please instantiate the Batcher with FlowController and ApiCallContext

Parameters:

batchingDescriptor - a BatchingDescriptor for transforming individual elements into wrappers request and response

unaryCallable - a UnaryCallable object

prototype - a BatcherImpl object

batchingSettings - a BatchingSettings with configuration of thresholds

BatcherImpl

@Deprecated
public BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor,
 UnaryCallable<RequestT,ResponseT> unaryCallable,
 RequestT prototype,
 BatchingSettings batchingSettings,
 ScheduledExecutorService executor,
 @Nullable
 FlowController flowController)

Deprecated.

Please instantiate the Batcher with ApiCallContext

Parameters:

batchingDescriptor - a BatchingDescriptor for transforming individual elements into wrappers request and response

unaryCallable - a UnaryCallable object

prototype - a BatcherImpl object

batchingSettings - a BatchingSettings with configuration of thresholds

flowController - a FlowController for throttling requests. If it's null, create a FlowController object from BatchingSettings.getFlowControlSettings().

BatcherImpl

public BatcherImpl(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor,
 UnaryCallable<RequestT,ResponseT> unaryCallable,
 RequestT prototype,
 BatchingSettings batchingSettings,
 ScheduledExecutorService executor,
 @Nullable
 FlowController flowController,
 @Nullable
 ApiCallContext callContext)

Parameters:

batchingDescriptor - a BatchingDescriptor for transforming individual elements into wrappers request and response

unaryCallable - a UnaryCallable object

prototype - a BatcherImpl object

batchingSettings - a BatchingSettings with configuration of thresholds

flowController - a FlowController for throttling requests. If it's null, create a FlowController object from BatchingSettings.getFlowControlSettings().

callContext - a ApiCallContext object that'll be merged in unaryCallable

Method Details

add

public ApiFuture<ElementResultT> add(ElementT element)

Queues the passed in element to be sent at some point in the future.

The element will be sent as part of a larger batch request at some point in the future. The returned ApiFuture will be resolved once the result for the element has been extracted from the batch response.

Note: Cancelling returned result simply marks the future cancelled, It would not stop the batch request.

Specified by:

add in interface Batcher<ElementT,ElementResultT>

flush

public void flush()
           throws InterruptedException

Synchronously sends any pending elements as a batch and waits for all outstanding batches to be complete.

Specified by:

flush in interface Batcher<ElementT,ElementResultT>

Throws:

InterruptedException

sendOutstanding

public void sendOutstanding()

Sends accumulated elements asynchronously for batching.

Note: This method can be invoked concurrently unlike Batcher.add(ElementT) and Batcher.close(), which can only be called from a single user thread. Please take caution to avoid race condition.

Specified by:

sendOutstanding in interface Batcher<ElementT,ElementResultT>

close

public void close()
           throws InterruptedException

Closes this Batcher by preventing new elements from being added, and then flushing the existing elements.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Batcher<ElementT,ElementResultT>

Throws:

InterruptedException

closeAsync

public ApiFuture<Void> closeAsync()

Description copied from interface: Batcher

Closes this Batcher by preventing new elements from being added, and then sending outstanding elements. The returned future will be resolved when the last element completes

Specified by:

closeAsync in interface Batcher<ElementT,ElementResultT>

getFlowController

@InternalApi("For google-cloud-java client use only")
public FlowController getFlowController()