The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"
job
google::cloud::batch::v1::Job const &
Required. The Job to create.
job_id
std::string const &
ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set.
The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.CreateJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.GetJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.batch.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.DeleteJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.batch.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
ListJobs(std::string const &, Options)
List all Jobs for a project within a region.
Parameters
Name
Description
parent
std::string const &
Parent path.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::batch::v1::Job >
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.batch.v1.Job, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.ListJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::batch::v1::Job >
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.batch.v1.Job, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
GetTask(std::string const &, Options)
Return a single Task.
Parameters
Name
Description
name
std::string const &
Required. Task name.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.GetTaskRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::batch::v1::Task >
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.batch.v1.Task, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.batch.v1.ListTasksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::batch::v1::Task >
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.batch.v1.Task, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
[[["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\u003eThe document details the Google Batch Service, which manages batch jobs and allocates Google Compute Engine VM instances.\u003c/p\u003e\n"],["\u003cp\u003eIt presents a list of available versions for the BatchServiceClient, ranging from version 2.11.0 up to the latest release candidate 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003eThe BatchServiceClient class offers methods for job management, including creating, retrieving, deleting, and listing jobs, as well as managing individual tasks.\u003c/p\u003e\n"],["\u003cp\u003eInstances of the BatchServiceClient can be copied and moved efficiently, sharing underlying resources, but concurrent access to the same instance by multiple threads is not guaranteed to work.\u003c/p\u003e\n"],["\u003cp\u003eCreating a new instance of the BatchServiceClient is expensive, as new connections are established; copy and move operations are much more efficient for sharing resources.\u003c/p\u003e\n"]]],[],null,["# Class BatchServiceClient (2.14.0)\n\nVersion 2.14.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/batch/latest/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.41.0](/cpp/docs/reference/batch/2.41.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.40.0](/cpp/docs/reference/batch/2.40.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.39.0](/cpp/docs/reference/batch/2.39.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.38.0](/cpp/docs/reference/batch/2.38.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.37.0](/cpp/docs/reference/batch/2.37.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.36.0](/cpp/docs/reference/batch/2.36.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.35.0](/cpp/docs/reference/batch/2.35.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.34.0](/cpp/docs/reference/batch/2.34.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.33.0](/cpp/docs/reference/batch/2.33.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.32.0](/cpp/docs/reference/batch/2.32.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.31.0](/cpp/docs/reference/batch/2.31.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.30.0](/cpp/docs/reference/batch/2.30.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.29.0](/cpp/docs/reference/batch/2.29.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.28.0](/cpp/docs/reference/batch/2.28.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.27.0](/cpp/docs/reference/batch/2.27.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.26.0](/cpp/docs/reference/batch/2.26.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.25.1](/cpp/docs/reference/batch/2.25.1/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.24.0](/cpp/docs/reference/batch/2.24.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.23.0](/cpp/docs/reference/batch/2.23.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.22.1](/cpp/docs/reference/batch/2.22.1/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.21.0](/cpp/docs/reference/batch/2.21.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.20.0](/cpp/docs/reference/batch/2.20.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.19.0](/cpp/docs/reference/batch/2.19.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.18.0](/cpp/docs/reference/batch/2.18.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.17.0](/cpp/docs/reference/batch/2.17.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.16.0](/cpp/docs/reference/batch/2.16.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.15.1](/cpp/docs/reference/batch/2.15.1/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.14.0](/cpp/docs/reference/batch/2.14.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.13.0](/cpp/docs/reference/batch/2.13.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.12.0](/cpp/docs/reference/batch/2.12.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient)\n- [2.11.0](/cpp/docs/reference/batch/2.11.0/classgoogle_1_1cloud_1_1batch__v1_1_1BatchServiceClient) \nGoogle Batch Service. \nThe service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.\n\n###### Equality\n\nInstances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal `std::shared_ptr\u003c*Connection\u003e` objects compare equal. Objects that compare equal share the same underlying resources.\n\n###### Performance\n\nCreating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.\n\n###### Thread Safety\n\nConcurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.\n\nConstructors\n------------\n\n### BatchServiceClient(BatchServiceClient const \\&)\n\nCopy and move support\n\n### BatchServiceClient(BatchServiceClient \\&\\&)\n\nCopy and move support\n\n### BatchServiceClient(std::shared_ptr\\\u003c BatchServiceConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(BatchServiceClient const \\&)\n\nCopy and move support\n\n### operator=(BatchServiceClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### CreateJob(std::string const \\&, google::cloud::batch::v1::Job const \\&, std::string const \\&, Options)\n\nCreate a Job.\n\n### CreateJob(google::cloud::batch::v1::CreateJobRequest const \\&, Options)\n\nCreate a Job.\n\n### GetJob(std::string const \\&, Options)\n\nGet a Job specified by its resource name.\n\n### GetJob(google::cloud::batch::v1::GetJobRequest const \\&, Options)\n\nGet a Job specified by its resource name.\n\n### DeleteJob(std::string const \\&, Options)\n\nDelete a Job.\n\n### DeleteJob(google::cloud::batch::v1::DeleteJobRequest const \\&, Options)\n\nDelete a Job.\n\n### ListJobs(std::string const \\&, Options)\n\nList all Jobs for a project within a region.\n\n### ListJobs(google::cloud::batch::v1::ListJobsRequest, Options)\n\nList all Jobs for a project within a region.\n\n### GetTask(std::string const \\&, Options)\n\nReturn a single Task.\n\n### GetTask(google::cloud::batch::v1::GetTaskRequest const \\&, Options)\n\nReturn a single Task.\n\n### ListTasks(std::string const \\&, Options)\n\nList Tasks associated with a job.\n\n### ListTasks(google::cloud::batch::v1::ListTasksRequest, Options)\n\nList Tasks associated with a job."]]
