Cloud Run Job Control Plane API.
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
JobsClient(JobsClient const &)
Copy and move support
JobsClient const &
JobsClient(JobsClient &&)
Copy and move support
JobsClient &&
JobsClient(std::shared_ptr< JobsConnection >, Options)
connection
std::shared_ptr< JobsConnection >
opts
Options
Operators
operator=(JobsClient const &)
Copy and move support
JobsClient const &
JobsClient &
operator=(JobsClient &&)
Copy and move support
JobsClient &&
JobsClient &
Functions
CreateJob(std::string const &, google::cloud::run::v2::Job const &, std::string const &, Options)
Creates a Job.
parent
std::string const &
Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
job
google::cloud::run::v2::Job const &
Required. The Job instance to create.
job_id
std::string const &
Required. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
CreateJob(NoAwaitTag, std::string const &, google::cloud::run::v2::Job const &, std::string const &, Options)
Creates 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.
NoAwaitTag
parent
std::string const &
job
google::cloud::run::v2::Job const &
job_id
std::string const &
opts
Options
StatusOr< google::longrunning::Operation >
CreateJob(google::cloud::run::v2::CreateJobRequest const &, Options)
Creates a Job.
request
google::cloud::run::v2::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.run.v2.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.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
CreateJob(NoAwaitTag, google::cloud::run::v2::CreateJobRequest const &, Options)
Creates 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.
NoAwaitTag
request
google::cloud::run::v2::CreateJobRequest const &
opts
Options
StatusOr< google::longrunning::Operation >
CreateJob(google::longrunning::Operation const &, Options)
Creates 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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::run::v2::Job > >
GetJob(std::string const &, Options)
Gets information about a Job.
name
std::string const &
Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
StatusOr< google::cloud::run::v2::Job >
the result of the RPC. The response message type ( google.cloud.run.v2.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::run::v2::GetJobRequest const &, Options)
Gets information about a Job.
request
google::cloud::run::v2::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.run.v2.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.
StatusOr< google::cloud::run::v2::Job >
the result of the RPC. The response message type ( google.cloud.run.v2.Job
) is mapped to a C++ class using the Protobuf mapping rules
. If the request fails, the StatusOr
contains the error details.
ListJobs(std::string const &, Options)
Lists Jobs.
Results are sorted by creation time, descending.
parent
std::string const &
Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
StreamRange< google::cloud::run::v2::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.run.v2.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::run::v2::ListJobsRequest, Options)
Lists Jobs.
Results are sorted by creation time, descending.
request
google::cloud::run::v2::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.run.v2.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.
StreamRange< google::cloud::run::v2::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.run.v2.Job
, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules
.
UpdateJob(google::cloud::run::v2::Job const &, Options)
Updates a Job.
job
google::cloud::run::v2::Job const &
Required. The Job to be updated.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
UpdateJob(NoAwaitTag, google::cloud::run::v2::Job const &, Options)
Updates 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.
NoAwaitTag
job
google::cloud::run::v2::Job const &
opts
Options
StatusOr< google::longrunning::Operation >
UpdateJob(google::cloud::run::v2::UpdateJobRequest const &, Options)
Updates a Job.
request
google::cloud::run::v2::UpdateJobRequest 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.run.v2.UpdateJobRequest
. 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.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
UpdateJob(NoAwaitTag, google::cloud::run::v2::UpdateJobRequest const &, Options)
Updates 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.
NoAwaitTag
request
google::cloud::run::v2::UpdateJobRequest const &
opts
Options
StatusOr< google::longrunning::Operation >
UpdateJob(google::longrunning::Operation const &, Options)
Updates 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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::run::v2::Job > >
DeleteJob(std::string const &, Options)
Deletes a Job.
name
std::string const &
Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
DeleteJob(NoAwaitTag, std::string const &, Options)
Deletes 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.
NoAwaitTag
name
std::string const &
opts
Options
StatusOr< google::longrunning::Operation >
DeleteJob(google::cloud::run::v2::DeleteJobRequest const &, Options)
Deletes a Job.
request
google::cloud::run::v2::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.run.v2.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.
future< StatusOr< google::cloud::run::v2::Job > >
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.run.v2.Job
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
DeleteJob(NoAwaitTag, google::cloud::run::v2::DeleteJobRequest const &, Options)
Deletes 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.
NoAwaitTag
request
google::cloud::run::v2::DeleteJobRequest const &
opts
Options
StatusOr< google::longrunning::Operation >
DeleteJob(google::longrunning::Operation const &, Options)
Deletes 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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::run::v2::Job > >
RunJob(std::string const &, Options)
Triggers creation of a new Execution of this Job.
name
std::string const &
Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
future< StatusOr< google::cloud::run::v2::Execution > >
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.run.v2.Execution
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
RunJob(NoAwaitTag, std::string const &, Options)
Triggers creation of a new Execution of this 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.
NoAwaitTag
name
std::string const &
opts
Options
StatusOr< google::longrunning::Operation >
RunJob(google::cloud::run::v2::RunJobRequest const &, Options)
Triggers creation of a new Execution of this Job.
request
google::cloud::run::v2::RunJobRequest 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.run.v2.RunJobRequest
. 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.
future< StatusOr< google::cloud::run::v2::Execution > >
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.run.v2.Execution
proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules
.
RunJob(NoAwaitTag, google::cloud::run::v2::RunJobRequest const &, Options)
Triggers creation of a new Execution of this 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.
NoAwaitTag
request
google::cloud::run::v2::RunJobRequest const &
opts
Options
StatusOr< google::longrunning::Operation >
RunJob(google::longrunning::Operation const &, Options)
Triggers creation of a new Execution of this 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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::run::v2::Execution > >
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the IAM Access Control policy currently in effect for the given Job.
This result does not include any inherited policies.
request
google::iam::v1::GetIamPolicyRequest 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.iam.v1.GetIamPolicyRequest
. 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.
StatusOr< google::iam::v1::Policy >
the result of the RPC. The response message type ( google.iam.v1.Policy
) is mapped to a C++ class using the Protobuf mapping rules
. If the request fails, the StatusOr
contains the error details.
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the IAM Access control policy for the specified Job.
Overwrites any existing policy.
request
google::iam::v1::SetIamPolicyRequest 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.iam.v1.SetIamPolicyRequest
. 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.
StatusOr< google::iam::v1::Policy >
the result of the RPC. The response message type ( google.iam.v1.Policy
) is mapped to a C++ class using the Protobuf mapping rules
. If the request fails, the StatusOr
contains the error details.
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified Project .
There are no permissions required for making this API call.
request
google::iam::v1::TestIamPermissionsRequest 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.iam.v1.TestIamPermissionsRequest
. 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.
StatusOr< google::iam::v1::TestIamPermissionsResponse >
the result of the RPC. The response message type ( google.iam.v1.TestIamPermissionsResponse
) is mapped to a C++ class using the Protobuf mapping rules
. If the request fails, the StatusOr
contains the error details.
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
.
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.
StreamRange< google::longrunning::Operation >
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.longrunning.Operation
, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules
.
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
.
request
google::longrunning::ListOperationsRequest
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.longrunning.ListOperationsRequest
. 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.
StreamRange< google::longrunning::Operation >
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.longrunning.Operation
, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules
.
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.
name
std::string const &
The name of the operation resource.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
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 StatusOr
contains the error details.
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.
request
google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest
. 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.
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 StatusOr
contains the error details.
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
.
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.
Status
a Status
object. If the request failed, the status contains the details of the failure.
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
.
request
google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest
. 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.
Status
a Status
object. If the request failed, the status contains the details of the failure.
WaitOperation(google::longrunning::WaitOperationRequest const &, Options)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
request
google::longrunning::WaitOperationRequest 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.longrunning.WaitOperationRequest
. 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.
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 StatusOr
contains the error details.
