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 <xref uid="com.google.api.gax.rpc.Batch.merge(com.google.api.gax.rpc.Batch<RequestT,ResponseT>)" data-throw-if-not-resolved="false">#merge(Batch)
method. Request objects are combined using a RequestBuilder into a single request.
This is public only for technical reasons, for advanced usage.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe latest version available for the \u003ccode\u003ecom.google.api.gax.rpc.Batch\u003c/code\u003e is 2.63.1, and there are many previous versions accessible, all the way back to 2.7.1.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBatch\u003c/code\u003e class is designed to manage a collection of requests that are to be batched into a single API call, and it is public only for technical reasons.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eBatch\u003c/code\u003e object includes a \u003ccode\u003eUnaryCallable\u003c/code\u003e for making API calls and a list of \u003ccode\u003eBatchedRequestIssuer\u003c/code\u003e objects, representing individual requests within the batch.\u003c/p\u003e\n"],["\u003cp\u003eBatches can be combined together using the \u003ccode\u003emerge\u003c/code\u003e method, which uses a \u003ccode\u003eRequestBuilder\u003c/code\u003e to combine individual requests into a unified request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBatch\u003c/code\u003e class has a constructor and several methods including \u003ccode\u003egetByteCount()\u003c/code\u003e, \u003ccode\u003egetCallable()\u003c/code\u003e, \u003ccode\u003egetRequest()\u003c/code\u003e, and \u003ccode\u003egetRequestIssuerList()\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class Batch<RequestT,ResponseT> (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.rpc.Batch)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.rpc.Batch)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.rpc.Batch)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.rpc.Batch)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.rpc.Batch)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.rpc.Batch)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.rpc.Batch)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.rpc.Batch)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.rpc.Batch)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.rpc.Batch)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.rpc.Batch)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.rpc.Batch)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.rpc.Batch)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.rpc.Batch)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.rpc.Batch)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.rpc.Batch)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.rpc.Batch)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.rpc.Batch)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.rpc.Batch)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.rpc.Batch)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.rpc.Batch)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.rpc.Batch)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.rpc.Batch)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.rpc.Batch)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.rpc.Batch)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.rpc.Batch)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.rpc.Batch)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.rpc.Batch)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.rpc.Batch)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.rpc.Batch)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.rpc.Batch)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.rpc.Batch)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.rpc.Batch)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.rpc.Batch)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.rpc.Batch)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.rpc.Batch)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.rpc.Batch)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.rpc.Batch)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.rpc.Batch)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.rpc.Batch)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.rpc.Batch)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.rpc.Batch)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.rpc.Batch)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.rpc.Batch)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.rpc.Batch)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.rpc.Batch)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.rpc.Batch)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.rpc.Batch)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.rpc.Batch)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.rpc.Batch)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.rpc.Batch)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.rpc.Batch)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.rpc.Batch)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.rpc.Batch) \n\n public class Batch\u003cRequestT,ResponseT\u003e\n\nA Batch contains a collection of requests that are to be batched into a single API call.\n\nA Batch contains a single [UnaryCallable](/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable) object, which will be used to make the API\ncall, and a list of [BatchedRequestIssuer](/java/docs/reference/gax/latest/com.google.api.gax.rpc.BatchedRequestIssuer) objects, which represent the individual requests\nin the batch.\n\nAdditional batches can be merged into an existing batch using the \\\u003cxref uid=\"com.google.api.gax.rpc.Batch.merge(com.google.api.gax.rpc.Batch\\\u003cRequestT,ResponseT\\\u003e)\" data-throw-if-not-resolved=\"false\"\\\u003e#merge(Batch)\nmethod. Request objects are combined using a [RequestBuilder](/java/docs/reference/gax/latest/com.google.api.gax.batching.RequestBuilder) into a single request.\n\nThis is public only for technical reasons, for advanced usage. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e Batch\\\u003cRequestT,ResponseT\\\u003e \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nConstructors\n------------\n\n### Batch(BatchingDescriptor\\\u003cRequestT,ResponseT\\\u003e descriptor, RequestT request, UnaryCallable\\\u003cRequestT,ResponseT\\\u003e callable, BatchedFuture\\\u003cResponseT\\\u003e batchedFuture)\n\n public Batch(BatchingDescriptor\u003cRequestT,ResponseT\u003e descriptor, RequestT request, UnaryCallable\u003cRequestT,ResponseT\u003e callable, BatchedFuture\u003cResponseT\u003e batchedFuture)\n\nMethods\n-------\n\n### getByteCount()\n\n public long getByteCount()\n\n### getCallable()\n\n public UnaryCallable\u003cRequestT,ResponseT\u003e getCallable()\n\n### getRequest()\n\n public RequestT getRequest()\n\n### getRequestIssuerList()\n\n public List\u003cBatchedRequestIssuer\u003cResponseT\u003e\u003e getRequestIssuerList()\n\n### merge(Batch\\\u003cRequestT,ResponseT\\\u003e batch)\n\n public void merge(Batch\u003cRequestT,ResponseT\u003e batch)\n\nMerge the given batch into this batch."]]
