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. |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |