Package com.google.api.gax.batching

Interface Summary

Interface	Description
Batcher<ElementT,ElementResultT>	Represents a batching context where individual elements will be accumulated and flushed in a large batch request at some point in the future.
BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT>	An adapter that packs and unpacks the elements in and out of batch requests and responses.
BatchingRequestBuilder<ElementT,RequestT>	Adapter to pack individual elements into a larger batch request.
BatchingThreshold<E>	The interface representing a threshold to be used in ThresholdBatcher.
BatchMerger<B>
ElementCounter<E>	Interface representing an object that provides a numerical count given an object of the parameterized type.
RequestBuilder<RequestT>
ThresholdBatchReceiver<BatchT>	Interface representing an object that receives batches from a ThresholdBatcher and takes action on them.

Class Summary

Class	Description
AccumulatingBatchReceiver<T>	A simple ThresholdBatchReceiver that just accumulates batches.
BatchEntry<ElementT,ElementResultT>	This class contains the element and its corresponding unresolved future, which would be resolved when batch is successful or failed.
BatcherImpl<ElementT,ElementResultT,RequestT,ResponseT>	Queues up the elements until BatcherImpl.flush() is called; once batching is over, returned future resolves.
BatchingCallSettings<ElementT,ElementResultT,RequestT,ResponseT>	This is an extension of UnaryCallSettings class to configure a UnaryCallable for calls to an API method that supports batching.
BatchingCallSettings.Builder<ElementT,ElementResultT,RequestT,ResponseT>	A base builder class for BatchingCallSettings.
BatchingFlowController<T>	Wraps a FlowController for use by batching.
BatchingSettings	Represents the batching settings to use for an API method that is capable of batching.
BatchingSettings.Builder	See the class documentation of BatchingSettings for a description of the different values that can be set.
BatchingThresholds	Factory methods for general-purpose batching thresholds.
DynamicFlowControlSettings	Settings for dynamic flow control
DynamicFlowControlSettings.Builder
FlowControlEventStats	Record the statistics of flow control events.
FlowControlEventStats.FlowControlEvent	A flow control event.
FlowController	Provides flow control capability.
FlowControlSettings	Settings for FlowController.
FlowControlSettings.Builder
NumericThreshold<E>	A threshold which accumulates a count based on the provided ElementCounter.
PartitionKey
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.
ThresholdBatcher.Builder<E>	Builder for a ThresholdBatcher.

Enum Summary

Enum	Description
FlowController.LimitExceededBehavior	Enumeration of behaviors that FlowController can use in case the flow control limits are exceeded.

Exception Summary

Exception	Description
BatchingException	Represents exception occurred during batching.
FlowController.FlowControlException	Base exception that signals a flow control state.
FlowController.FlowControlRuntimeException	Runtime exception that can be used in place of FlowControlException when an unchecked exception is required.
FlowController.MaxOutstandingElementCountReachedException	Exception thrown when client-side flow control is enforced based on the maximum number of outstanding in-memory elements.
FlowController.MaxOutstandingRequestBytesReachedException	Exception thrown when client-side flow control is enforced based on the maximum number of unacknowledged in-memory bytes.