The returned connection object should not be used directly; instead it should be passed as an argument to the constructor ofBatchServiceClient.
The optionaloptionsargument may be used to configure aspects of the returnedBatchServiceConnection. Expected options are any of the types in the following option lists:
[[["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-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the Google Cloud Batch C++ client library, with version 2.21.0 being the current version discussed on the page, and 2.37.0-rc being the latest.\u003c/p\u003e\n"],["\u003cp\u003eThe content includes links to documentation for various versions of the Batch service, ranging from version 2.11.0 up to the most recent release candidate 2.37.0-rc, with 2.21.0 being the central focus.\u003c/p\u003e\n"],["\u003cp\u003eKey classes documented on this page are \u003ccode\u003eBatchServiceClient\u003c/code\u003e and \u003ccode\u003eBatchServiceConnection\u003c/code\u003e, including other related classes that handle retry and connection policies such as \u003ccode\u003eBatchServiceConnectionIdempotencyPolicy\u003c/code\u003e, \u003ccode\u003eBatchServiceRetryPolicy\u003c/code\u003e, and their variants.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation includes details on how to create a \u003ccode\u003eBatchServiceConnection\u003c/code\u003e using the \u003ccode\u003eMakeBatchServiceConnection\u003c/code\u003e function, as well as how to configure the connection using different option lists like \u003ccode\u003eCommonOptionList\u003c/code\u003e, \u003ccode\u003eGrpcOptionList\u003c/code\u003e, \u003ccode\u003eUnifiedCredentialsOptionList\u003c/code\u003e, and \u003ccode\u003eBatchServicePolicyOptionList\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe content details the usage of various structs, such as \u003ccode\u003eBatchServiceBackoffPolicyOption\u003c/code\u003e, \u003ccode\u003eBatchServiceConnectionIdempotencyPolicyOption\u003c/code\u003e, \u003ccode\u003eBatchServicePollingPolicyOption\u003c/code\u003e, \u003ccode\u003eBatchServiceRetryPolicyOption\u003c/code\u003e and the type alias \u003ccode\u003eBatchServicePolicyOptionList\u003c/code\u003e to facilitate the configuration and management of Batch service interactions.\u003c/p\u003e\n"]]],[],null,["# Namespace google::cloud::batch_v1 (2.21.0)\n\nVersion 2.21.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/batch/latest/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.41.0](/cpp/docs/reference/batch/2.41.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.40.0](/cpp/docs/reference/batch/2.40.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.39.0](/cpp/docs/reference/batch/2.39.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.38.0](/cpp/docs/reference/batch/2.38.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.37.0](/cpp/docs/reference/batch/2.37.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.36.0](/cpp/docs/reference/batch/2.36.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.35.0](/cpp/docs/reference/batch/2.35.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.34.0](/cpp/docs/reference/batch/2.34.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.33.0](/cpp/docs/reference/batch/2.33.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.32.0](/cpp/docs/reference/batch/2.32.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.31.0](/cpp/docs/reference/batch/2.31.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.30.0](/cpp/docs/reference/batch/2.30.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.29.0](/cpp/docs/reference/batch/2.29.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.28.0](/cpp/docs/reference/batch/2.28.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.27.0](/cpp/docs/reference/batch/2.27.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.26.0](/cpp/docs/reference/batch/2.26.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.25.1](/cpp/docs/reference/batch/2.25.1/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.24.0](/cpp/docs/reference/batch/2.24.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.23.0](/cpp/docs/reference/batch/2.23.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.22.1](/cpp/docs/reference/batch/2.22.1/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.21.0](/cpp/docs/reference/batch/2.21.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.20.0](/cpp/docs/reference/batch/2.20.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.19.0](/cpp/docs/reference/batch/2.19.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.18.0](/cpp/docs/reference/batch/2.18.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.17.0](/cpp/docs/reference/batch/2.17.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.16.0](/cpp/docs/reference/batch/2.16.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.15.1](/cpp/docs/reference/batch/2.15.1/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.14.0](/cpp/docs/reference/batch/2.14.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.13.0](/cpp/docs/reference/batch/2.13.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.12.0](/cpp/docs/reference/batch/2.12.0/namespacegoogle_1_1cloud_1_1batch__v1)\n- [2.11.0](/cpp/docs/reference/batch/2.11.0/namespacegoogle_1_1cloud_1_1batch__v1) \n\nClasses\n-------\n\n### [BatchServiceClient](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n\nGoogle Batch Service.\n\n### [BatchServiceConnection](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection)\n\nThe [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection) object for [`BatchServiceClient`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient).\n\n### [BatchServiceConnectionIdempotencyPolicy](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnectionIdempotencyPolicy)\n\n### [BatchServiceLimitedErrorCountRetryPolicy](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceLimitedErrorCountRetryPolicy)\n\nA retry policy for [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection) based on counting errors.\n\n### [BatchServiceLimitedTimeRetryPolicy](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceLimitedTimeRetryPolicy)\n\nA retry policy for [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection) based on elapsed time.\n\n### [BatchServiceRetryPolicy](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceRetryPolicy)\n\nThe retry policy for [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection).\n\nStructs\n-------\n\n### [BatchServiceBackoffPolicyOption](/cpp/docs/reference/batch/2.21.0/structgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceBackoffPolicyOption)\n\nUse with [`google::cloud::Options`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Options.html) to configure the backoff policy.\n\n### [BatchServiceConnectionIdempotencyPolicyOption](/cpp/docs/reference/batch/2.21.0/structgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnectionIdempotencyPolicyOption)\n\nUse with [`google::cloud::Options`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Options.html) to configure which operations are retried.\n\n### [BatchServicePollingPolicyOption](/cpp/docs/reference/batch/2.21.0/structgoogle_1_1cloud_1_1batch__v1_1_1BatchServicePollingPolicyOption)\n\nUse with [`google::cloud::Options`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Options.html) to configure the long-running operations polling policy.\n\n### [BatchServiceRetryPolicyOption](/cpp/docs/reference/batch/2.21.0/structgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceRetryPolicyOption)\n\nUse with [`google::cloud::Options`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Options.html) to configure the retry policy.\n\nFunctions\n---------\n\n### MakeBatchServiceConnection(Options)\n\nA factory function to construct an object of type [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection). \nThe returned connection object should not be used directly; instead it should be passed as an argument to the constructor of [BatchServiceClient](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient).\n\nThe optional `options` argument may be used to configure aspects of the returned [`BatchServiceConnection`](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceConnection). Expected options are any of the types in the following option lists:\n\n- [`google::cloud::CommonOptionList`](https://cloud.google.com/cpp/docs/reference/common/latest/namespacegoogle_1_1cloud.html)\n- [`google::cloud::GrpcOptionList`](https://cloud.google.com/cpp/docs/reference/common/latest/namespacegoogle_1_1cloud.html)\n- [`google::cloud::UnifiedCredentialsOptionList`](https://cloud.google.com/cpp/docs/reference/common/latest/namespacegoogle_1_1cloud.html)\n- [`google::cloud::batch_v1::BatchServicePolicyOptionList`](/cpp/docs/reference/batch/2.21.0/namespacegoogle_1_1cloud_1_1batch__v1)\n\n| **Note:** Unexpected options will be ignored. To log unexpected options instead, set `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes` in the environment.\n\n### MakeDefaultBatchServiceConnectionIdempotencyPolicy()\n\nType Aliases\n------------\n\n### BatchServicePolicyOptionList\n\n**Alias Of** : `OptionList\u003c BatchServiceRetryPolicyOption, BatchServiceBackoffPolicyOption, BatchServicePollingPolicyOption, BatchServiceConnectionIdempotencyPolicyOption \u003e` \nThe options applicable to BatchService."]]
