Class JobControllerClient (2.19.0)

Version 2.19.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The JobController provides methods to manage 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

JobControllerClient(JobControllerClient const &)

Copy and move support

Parameter
Name	Description
	JobControllerClient const &

JobControllerClient(JobControllerClient &&)

Copy and move support

Parameter
Name	Description
	JobControllerClient &&

JobControllerClient(std::shared_ptr< JobControllerConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< JobControllerConnection >
opts	Options

Operators

operator=(JobControllerClient const &)

Copy and move support

Parameter
Name	Description
	JobControllerClient const &

Returns
Type	Description
JobControllerClient &

operator=(JobControllerClient &&)

Copy and move support

Parameter
Name	Description
	JobControllerClient &&

Returns
Type	Description
JobControllerClient &

Functions

SubmitJob(std::string const &, std::string const &, google::cloud::dataproc::v1::Job const &, Options)

Submits a job to a cluster.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
job	google::cloud::dataproc::v1::Job const & Required. The job resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

SubmitJob(google::cloud::dataproc::v1::SubmitJobRequest const &, Options)

Submits a job to a cluster.

Parameters
Name	Description
request	google::cloud::dataproc::v1::SubmitJobRequest 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.dataproc.v1.SubmitJobRequest. 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::dataproc::v1::Job >	the result of the RPC. The response message type (google.cloud.dataproc.v1.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SubmitJobAsOperation(std::string const &, std::string const &, google::cloud::dataproc::v1::Job const &, Options)

Submits job to a cluster.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
job	google::cloud::dataproc::v1::Job const & Required. The job resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataproc::v1::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.dataproc.v1.Job proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SubmitJobAsOperation(google::cloud::dataproc::v1::SubmitJobRequest const &, Options)

Submits job to a cluster.

Parameters
Name	Description
request	google::cloud::dataproc::v1::SubmitJobRequest 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.dataproc.v1.SubmitJobRequest. 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::dataproc::v1::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.dataproc.v1.Job proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetJob(std::string const &, std::string const &, std::string const &, Options)

Gets the resource representation for a job in a project.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
job_id	std::string const & Required. The job ID.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::Job >	the result of the RPC. The response message type (google.cloud.dataproc.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::dataproc::v1::GetJobRequest const &, Options)

Gets the resource representation for a job in a project.

Parameters
Name	Description
request	google::cloud::dataproc::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.dataproc.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::dataproc::v1::Job >	the result of the RPC. The response message type (google.cloud.dataproc.v1.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 &, std::string const &, Options)

Lists regions/{region}/jobs in a project.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dataproc::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.dataproc.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(std::string const &, std::string const &, std::string const &, Options)

Lists regions/{region}/jobs in a project.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
filter	std::string const & Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator. Example filter: status.state = ACTIVE AND labels.env = staging AND labels.starred = *
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dataproc::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.dataproc.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::dataproc::v1::ListJobsRequest, Options)

Lists regions/{region}/jobs in a project.

Parameters
Name	Description
request	google::cloud::dataproc::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.dataproc.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::dataproc::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.dataproc.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.

UpdateJob(google::cloud::dataproc::v1::UpdateJobRequest const &, Options)

Updates a job in a project.

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

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

CancelJob(std::string const &, std::string const &, std::string const &, Options)

Starts a job cancellation request.

To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
job_id	std::string const & Required. The job ID.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CancelJob(google::cloud::dataproc::v1::CancelJobRequest const &, Options)

Starts a job cancellation request.

To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters
Name	Description
request	google::cloud::dataproc::v1::CancelJobRequest 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.dataproc.v1.CancelJobRequest. 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::dataproc::v1::Job >	the result of the RPC. The response message type (google.cloud.dataproc.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 &, std::string const &, std::string const &, Options)

Deletes the job from the project.

If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters
Name	Description
project_id	std::string const & Required. The ID of the Google Cloud Platform project that the job belongs to.
region	std::string const & Required. The Dataproc region in which to handle the request.
job_id	std::string const & Required. The job 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.

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

Deletes the job from the project.

If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters
Name	Description
request	google::cloud::dataproc::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.dataproc.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
Status	a Status object. If the request failed, the status contains the details of the failure.