An idiomatic C++ client library for the Batch API, a fully managed service to schedule, queue, and execute batch jobs on Google's infrastructure.
Quickstart
The following shows the code that you'll run in the google/cloud/batch/quickstart/ directory, which should give you a taste of the Batch API C++ client library API.
The main class in this library is batch_v1::BatchServiceClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock batch_v1::BatchServiceClient when testing your application.
More Information
Error Handling - describes how the library reports errors.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the Batch API C++ Client Library, offering a way to schedule, queue, and execute batch jobs on Google infrastructure.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate version available is 2.37.0-rc, and the page lists versions ranging from 2.37.0-rc down to version 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003eThe primary class to utilize the Batch API is \u003ccode\u003ebatch_v1::BatchServiceClient\u003c/code\u003e, which exposes all Remote Procedure Calls (RPCs) as member functions.\u003c/p\u003e\n"],["\u003cp\u003eThe provided quickstart example demonstrates how to use the Batch API C++ Client Library by listing jobs using the \u003ccode\u003eListJobs\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAdditional information covers topics like error handling, overriding the default endpoint and authentication credentials, changing retry policies, and environment variable configurations.\u003c/p\u003e\n"]]],[],null,["Version 2.13.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/batch/latest)\n- [2.41.0](/cpp/docs/reference/batch/2.41.0)\n- [2.40.0](/cpp/docs/reference/batch/2.40.0)\n- [2.39.0](/cpp/docs/reference/batch/2.39.0)\n- [2.38.0](/cpp/docs/reference/batch/2.38.0)\n- [2.37.0](/cpp/docs/reference/batch/2.37.0)\n- [2.36.0](/cpp/docs/reference/batch/2.36.0)\n- [2.35.0](/cpp/docs/reference/batch/2.35.0)\n- [2.34.0](/cpp/docs/reference/batch/2.34.0)\n- [2.33.0](/cpp/docs/reference/batch/2.33.0)\n- [2.32.0](/cpp/docs/reference/batch/2.32.0)\n- [2.31.0](/cpp/docs/reference/batch/2.31.0)\n- [2.30.0](/cpp/docs/reference/batch/2.30.0)\n- [2.29.0](/cpp/docs/reference/batch/2.29.0)\n- [2.28.0](/cpp/docs/reference/batch/2.28.0)\n- [2.27.0](/cpp/docs/reference/batch/2.27.0)\n- [2.26.0](/cpp/docs/reference/batch/2.26.0)\n- [2.25.1](/cpp/docs/reference/batch/2.25.1)\n- [2.24.0](/cpp/docs/reference/batch/2.24.0)\n- [2.23.0](/cpp/docs/reference/batch/2.23.0)\n- [2.22.1](/cpp/docs/reference/batch/2.22.1)\n- [2.21.0](/cpp/docs/reference/batch/2.21.0)\n- [2.20.0](/cpp/docs/reference/batch/2.20.0)\n- [2.19.0](/cpp/docs/reference/batch/2.19.0)\n- [2.18.0](/cpp/docs/reference/batch/2.18.0)\n- [2.17.0](/cpp/docs/reference/batch/2.17.0)\n- [2.16.0](/cpp/docs/reference/batch/2.16.0)\n- [2.15.1](/cpp/docs/reference/batch/2.15.1)\n- [2.14.0](/cpp/docs/reference/batch/2.14.0)\n- [2.13.0](/cpp/docs/reference/batch/2.13.0)\n- [2.12.0](/cpp/docs/reference/batch/2.12.0)\n- [2.11.0](/cpp/docs/reference/batch/2.11.0) \n\nBatch API C++ Client Library\n============================\n\nAn idiomatic C++ client library for the [Batch API](https://cloud.google.com/batch), a fully managed service to schedule, queue, and execute batch jobs on Google's infrastructure.\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/batch/quickstart/` directory, which should give you a taste of the Batch API C++ client library API. \n\n #include \"google/cloud/batch/v1/batch_client.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 3) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id region-id\\n\";\n return 1;\n }\n\n namespace batch = ::google::cloud::batch_v1;\n auto client = batch::BatchServiceClient(batch::MakeBatchServiceConnection());\n\n auto const location =\n std::string{\"projects/\"} + argv[1] + \"/locations/\" + argv[2];\n for (auto r : client.ListJobs(location)) {\n if (!r) throw std::move(r).status();\n std::cout \u003c\u003c r-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThe main class in this library is [`batch_v1::BatchServiceClient`](/cpp/docs/reference/batch/2.13.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`batch_v1::BatchServiceClient`](/cpp/docs/reference/batch/2.13.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient) when testing your application.\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/batch/2.13.0/batch-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/batch/2.13.0/batch-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/batch/2.13.0/batch-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/batch/2.13.0/batch-env) - describes environment variables that can configure the behavior of the library."]]