Class BatchServiceClient (2.30.0)

Google Batch Service.

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.

Constructors

BatchServiceClient(BatchServiceClient const &)

Copy and move support

Parameter
Name	Description
	`BatchServiceClient const &`

BatchServiceClient(BatchServiceClient &&)

Copy and move support

Parameter
Name	Description
	`BatchServiceClient &&`

BatchServiceClient(std::shared_ptr< BatchServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< BatchServiceConnection >`
`opts`	`Options`

Operators

operator=(BatchServiceClient const &)

Copy and move support

Parameter
Name	Description
	`BatchServiceClient const &`

Returns
Type	Description
`BatchServiceClient &`

operator=(BatchServiceClient &&)

Copy and move support

Parameter
Name	Description
	`BatchServiceClient &&`

Returns
Type	Description
`BatchServiceClient &`

Functions

CreateJob(std::string const &, google::cloud::batch::v1::Job const &, std::string const &, Options)

Create a Job.

Parameters
Name	Description
`parent`	`std::string const &` 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.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Job >`	the result of the RPC. The response message type (google.cloud.batch.v1.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateJob(google::cloud::batch::v1::CreateJobRequest const &, Options)

Create a Job.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::CreateJobRequest const &` 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.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Job >`	the result of the RPC. The response message type (google.cloud.batch.v1.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJob(std::string const &, Options)

Get a Job specified by its resource name.

Parameters
Name	Description
`name`	`std::string const &` Required. Job name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Job >`	the result of the RPC. The response message type (google.cloud.batch.v1.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJob(google::cloud::batch::v1::GetJobRequest const &, Options)

Get a Job specified by its resource name.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::GetJobRequest const &` 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.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Job >`	the result of the RPC. The response message type (google.cloud.batch.v1.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteJob(std::string const &, Options)

Delete a Job.

Parameters
Name	Description
`name`	`std::string const &` Job name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::batch::v1::OperationMetadata > >

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.

DeleteJob(NoAwaitTag, std::string const &, Options)

Delete a Job.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteJob(google::cloud::batch::v1::DeleteJobRequest const &, Options)

Delete a Job.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::DeleteJobRequest const &` 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.

Returns

Type Description

future< StatusOr< google::cloud::batch::v1::OperationMetadata > >

DeleteJob(NoAwaitTag, google::cloud::batch::v1::DeleteJobRequest const &, Options)

Delete a Job.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::batch::v1::DeleteJobRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteJob(google::longrunning::Operation const &, Options)

Delete a Job.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::batch::v1::OperationMetadata > >`

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.

ListJobs(google::cloud::batch::v1::ListJobsRequest, Options)

List all Jobs for a project within a region.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::ListJobsRequest` 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 >

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.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Task >`	the result of the RPC. The response message type (google.cloud.batch.v1.Task) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTask(google::cloud::batch::v1::GetTaskRequest const &, Options)

Return a single Task.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::GetTaskRequest const &` 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.

Returns
Type	Description
`StatusOr< google::cloud::batch::v1::Task >`	the result of the RPC. The response message type (google.cloud.batch.v1.Task) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListTasks(std::string const &, Options)

List Tasks associated with a job.

Parameters
Name	Description
`parent`	`std::string const &` 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.

ListTasks(google::cloud::batch::v1::ListTasksRequest, Options)

List Tasks associated with a job.

Parameters
Name	Description
`request`	`google::cloud::batch::v1::ListTasksRequest` 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.