Class Batch<RequestT,ResponseT> (2.10.0)

publicclassBatch<RequestT,ResponseT>

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

A Batch contains a singleUnaryCallable object, which will be used to make the API call, and a list ofBatchedRequestIssuer 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 aRequestBuilder into a single request.

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

Inheritance

java.lang.Object >Batch<RequestT,ResponseT>

Type Parameters

NameDescription
RequestT
ResponseT

Constructors

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

publicBatch(BatchingDescriptor<RequestT,ResponseT>descriptor,RequestTrequest,UnaryCallable<RequestT,ResponseT>callable,BatchedFuture<ResponseT>batchedFuture)
Parameters
NameDescription
descriptorBatchingDescriptor<RequestT,ResponseT>
requestRequestT
callableUnaryCallable<RequestT,ResponseT>
batchedFutureBatchedFuture<ResponseT>

Methods

getByteCount()

publiclonggetByteCount()
Returns
TypeDescription
long

getCallable()

publicUnaryCallable<RequestT,ResponseT>getCallable()
Returns
TypeDescription
UnaryCallable<RequestT,ResponseT>

getRequest()

publicRequestTgetRequest()
Returns
TypeDescription
RequestT

getRequestIssuerList()

publicList<BatchedRequestIssuer<ResponseT>>getRequestIssuerList()
Returns
TypeDescription
List<BatchedRequestIssuer<ResponseT>>

merge(Batch<RequestT,ResponseT> batch)

publicvoidmerge(Batch<RequestT,ResponseT>batch)

Merge the given batch into this batch.

Parameter
NameDescription
batchBatch<RequestT,ResponseT>

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.