com.google.api.gax.rpc

Class Batch<RequestT,ResponseT>

java.lang.Object

com.google.api.gax.rpc.Batch<RequestT,ResponseT>

@InternalApi
public class Batch<RequestT,ResponseT>
extends Object

A Batch contains a collection of requests that are to be batched into a single API call.

A Batch contains a single UnaryCallable object, which will be used to make the API call, and a list of BatchedRequestIssuer objects, which represent the individual requests in the batch.

Additional batches can be merged into an existing batch using the merge(Batch) method. Request objects are combined using a RequestBuilder into a single request.

This is public only for technical reasons, for advanced usage.

Constructor Summary

Constructors

Constructor and Description
Batch(BatchingDescriptor<RequestT,ResponseT> descriptor, RequestT request, UnaryCallable<RequestT,ResponseT> callable, BatchedFuture<ResponseT> batchedFuture)

Method Summary

Modifier and Type	Method and Description
long	getByteCount()
UnaryCallable<RequestT,ResponseT>	getCallable()
RequestT	getRequest()
List<BatchedRequestIssuer<ResponseT>>	getRequestIssuerList()
void	merge(Batch<RequestT,ResponseT> batch) Merge the given batch into this batch.

Methods inherited from class java.lang.Object

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

Constructor Detail

Batch

public Batch(BatchingDescriptor<RequestT,ResponseT> descriptor,
             RequestT request,
             UnaryCallable<RequestT,ResponseT> callable,
             BatchedFuture<ResponseT> batchedFuture)

Method Detail

getRequest

public RequestT getRequest()

getCallable

public UnaryCallable<RequestT,ResponseT> getCallable()

getRequestIssuerList

public List<BatchedRequestIssuer<ResponseT>> getRequestIssuerList()

getByteCount

public long getByteCount()

merge

public void merge(Batch<RequestT,ResponseT> batch)

Merge the given batch into this batch.