The BatchController provides methods to manage batch workloads.
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.
Creates a batch workload that executes asynchronously.
Parameters
Name
Description
parent
std::string const &
Required. The parent resource where this batch will be created.
batch
google::cloud::dataproc::v1::Batch const &
Required. The batch to create.
batch_id
std::string const &
Optional. The ID to use for the batch, which will become the final component of the batch's resource name.
This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.
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.dataproc.v1.Batch 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.dataproc.v1.CreateBatchRequest. 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.dataproc.v1.Batch proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
GetBatch(std::string const &, Options)
Gets the batch workload resource representation.
Parameters
Name
Description
name
std::string const &
Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_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.dataproc.v1.GetBatchRequest. 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. The parent, which owns this collection of batches.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::dataproc::v1::Batch >
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.dataproc.v1.Batch, 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.dataproc.v1.ListBatchesRequest. 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::dataproc::v1::Batch >
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.dataproc.v1.Batch, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
DeleteBatch(std::string const &, Options)
Deletes the batch workload resource.
If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.
Parameters
Name
Description
name
std::string const &
Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
Status
a Status object. If the request failed, the status contains the details of the failure.
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.dataproc.v1.DeleteBatchRequest. 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
Status
a Status object. If the request failed, the status contains the details of the failure.
[[["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 latest version of the BatchControllerClient is 2.37.0-rc, with several other versions available, ranging from 2.36.0 down to 2.11.0, providing options for different development needs.\u003c/p\u003e\n"],["\u003cp\u003eThe BatchControllerClient provides a suite of methods to manage batch workloads asynchronously, including creating, retrieving, listing, and deleting batch workloads, which are essential for managing long-running tasks.\u003c/p\u003e\n"],["\u003cp\u003eCopy-constructing or copy-assigning instances of BatchControllerClient is efficient because copies share the same underlying resources, whereas creating new instances is more expensive as it establishes new service connections.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCreateBatch\u003c/code\u003e function allows for creating a new batch workload with specified parameters like parent resource, batch details, and optional batch ID, returning a future that completes upon the long-running operation's success or failure.\u003c/p\u003e\n"],["\u003cp\u003eThe functions \u003ccode\u003eGetBatch\u003c/code\u003e, \u003ccode\u003eListBatches\u003c/code\u003e and \u003ccode\u003eDeleteBatch\u003c/code\u003e can be called either by passing in the relevant ID strings, or by passing in a complete pre-built request object.\u003c/p\u003e\n"]]],[],null,["# Class BatchControllerClient (2.21.0)\n\nVersion 2.21.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/dataproc/latest/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.41.0](/cpp/docs/reference/dataproc/2.41.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.40.0](/cpp/docs/reference/dataproc/2.40.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.39.0](/cpp/docs/reference/dataproc/2.39.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.38.0](/cpp/docs/reference/dataproc/2.38.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.37.0](/cpp/docs/reference/dataproc/2.37.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.36.0](/cpp/docs/reference/dataproc/2.36.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.35.0](/cpp/docs/reference/dataproc/2.35.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.34.0](/cpp/docs/reference/dataproc/2.34.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.33.0](/cpp/docs/reference/dataproc/2.33.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.32.0](/cpp/docs/reference/dataproc/2.32.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.31.0](/cpp/docs/reference/dataproc/2.31.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.30.0](/cpp/docs/reference/dataproc/2.30.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.29.0](/cpp/docs/reference/dataproc/2.29.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.28.0](/cpp/docs/reference/dataproc/2.28.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.27.0](/cpp/docs/reference/dataproc/2.27.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.26.0](/cpp/docs/reference/dataproc/2.26.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.25.1](/cpp/docs/reference/dataproc/2.25.1/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.24.0](/cpp/docs/reference/dataproc/2.24.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.23.0](/cpp/docs/reference/dataproc/2.23.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.22.1](/cpp/docs/reference/dataproc/2.22.1/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.21.0](/cpp/docs/reference/dataproc/2.21.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.20.0](/cpp/docs/reference/dataproc/2.20.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.19.0](/cpp/docs/reference/dataproc/2.19.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.18.0](/cpp/docs/reference/dataproc/2.18.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.17.0](/cpp/docs/reference/dataproc/2.17.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.16.0](/cpp/docs/reference/dataproc/2.16.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.15.1](/cpp/docs/reference/dataproc/2.15.1/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.14.0](/cpp/docs/reference/dataproc/2.14.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.13.0](/cpp/docs/reference/dataproc/2.13.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.12.0](/cpp/docs/reference/dataproc/2.12.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient)\n- [2.11.0](/cpp/docs/reference/dataproc/2.11.0/classgoogle_1_1cloud_1_1dataproc__v1_1_1BatchControllerClient) \nThe BatchController provides methods to manage batch workloads. \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### BatchControllerClient(BatchControllerClient const \\&)\n\nCopy and move support\n\n### BatchControllerClient(BatchControllerClient \\&\\&)\n\nCopy and move support\n\n### BatchControllerClient(std::shared_ptr\\\u003c BatchControllerConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(BatchControllerClient const \\&)\n\nCopy and move support\n\n### operator=(BatchControllerClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### CreateBatch(std::string const \\&, google::cloud::dataproc::v1::Batch const \\&, std::string const \\&, Options)\n\nCreates a batch workload that executes asynchronously.\n\n### CreateBatch(google::cloud::dataproc::v1::CreateBatchRequest const \\&, Options)\n\nCreates a batch workload that executes asynchronously.\n\n### GetBatch(std::string const \\&, Options)\n\nGets the batch workload resource representation.\n\n### GetBatch(google::cloud::dataproc::v1::GetBatchRequest const \\&, Options)\n\nGets the batch workload resource representation.\n\n### ListBatches(std::string const \\&, Options)\n\nLists batch workloads.\n\n### ListBatches(google::cloud::dataproc::v1::ListBatchesRequest, Options)\n\nLists batch workloads.\n\n### DeleteBatch(std::string const \\&, Options)\n\nDeletes the batch workload resource. \nIf the batch is not in terminal state, the delete fails and the response returns `FAILED_PRECONDITION`.\n\n### DeleteBatch(google::cloud::dataproc::v1::DeleteBatchRequest const \\&, Options)\n\nDeletes the batch workload resource. \nIf the batch is not in terminal state, the delete fails and the response returns `FAILED_PRECONDITION`."]]
