Reference documentation and code samples for the Google Cloud Dataproc V1 Client class JobControllerClient.
Service Description: The JobController provides methods to manage jobs.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$jobControllerClient = new JobControllerClient();
try {
$projectId = 'project_id';
$region = 'region';
$jobId = 'job_id';
$response = $jobControllerClient->cancelJob($projectId, $region, $jobId);
} finally {
$jobControllerClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Dataproc\V1\Client\JobControllerClient to use the new surface.
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
cancelJob
Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get .
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
jobId
string
Required. The job ID.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function cancel_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->cancelJob($projectId, $region, $jobId);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
cancel_job_sample($projectId, $region, $jobId);
}
deleteJob
Deletes the job from the project. If the job is active, the delete fails,
and the response returns FAILED_PRECONDITION
.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
jobId
string
Required. The job ID.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\JobControllerClient;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function delete_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Call the API and handle any network failures.
try {
$jobControllerClient->deleteJob($projectId, $region, $jobId);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
delete_job_sample($projectId, $region, $jobId);
}
getJob
Gets the resource representation for a job in a project.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
jobId
string
Required. The job ID.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function get_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->getJob($projectId, $region, $jobId);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
get_job_sample($projectId, $region, $jobId);
}
listJobs
Lists regions/{region}/jobs in a project.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ clusterName
string
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
↳ jobStateMatcher
int
Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If filter
is provided, jobStateMatcher
will be ignored. For allowed values, use constants defined on Google\Cloud\Dataproc\V1\ListJobsRequest\JobStateMatcher
↳ filter
string
Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where fieldis status.state
or labels.[KEY]
, and [KEY]
is a label key. valuecan 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 = *
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
*/
function list_jobs_sample(string $projectId, string $region): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $jobControllerClient->listJobs($projectId, $region);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
list_jobs_sample($projectId, $region);
}
submitJob
Submits a job to a cluster.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
job
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest s with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned. It is recommended to always set this value to a UUID . The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
use Google\Cloud\Dataproc\V1\JobPlacement;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function submit_job_sample(
string $projectId,
string $region,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare any non-scalar elements to be passed along with the request.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->submitJob($projectId, $region, $job);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
submit_job_sample($projectId, $region, $jobPlacementClusterName);
}
submitJobAsOperation
Submits job to a cluster.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
job
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest s with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned. It is recommended to always set this value to a UUID . The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
use Google\Cloud\Dataproc\V1\JobPlacement;
use Google\Rpc\Status;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function submit_job_as_operation_sample(
string $projectId,
string $region,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare any non-scalar elements to be passed along with the request.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobControllerClient->submitJobAsOperation($projectId, $region, $job);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Job $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
submit_job_as_operation_sample($projectId, $region, $jobPlacementClusterName);
}
updateJob
Updates a job in a project.
projectId
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
region
string
Required. The Dataproc region in which to handle the request.
jobId
string
Required. The job ID.
job
updateMask
Google\Protobuf\FieldMask
Required. Specifies the path, relative to Job
, of
the field to update. For example, to update the labels of a Job the update_mask
parameter would be specified as labels
, and the PATCH
request body would specify the new
value. Note:Currently, labels
is the only
field that can be updated.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobControllerClient;
use Google\Cloud\Dataproc\V1\JobPlacement;
use Google\Protobuf\FieldMask;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function update_job_sample(
string $projectId,
string $region,
string $jobId,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare any non-scalar elements to be passed along with the request.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->updateJob($projectId, $region, $jobId, $job, $updateMask);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
update_job_sample($projectId, $region, $jobId, $jobPlacementClusterName);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
Constants
SERVICE_NAME
Value: 'google.cloud.dataproc.v1.JobController'
The name of the service.
SERVICE_ADDRESS
Value: 'dataproc.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.