JobControllerClient

JobControllerClient

The JobController provides methods to manage jobs.

Constructor

new JobControllerClient(optionsopt)

Construct an instance of JobControllerClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

cancelJob(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
jobId string

Required. The job ID.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const jobId = '';
const request = {
  projectId: projectId,
  region: region,
  jobId: jobId,
};
client.cancelJob(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteJob(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
jobId string

Required. The job ID.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const jobId = '';
const request = {
  projectId: projectId,
  region: region,
  jobId: jobId,
};
client.deleteJob(request).catch(err => {
  console.error(err);
});

getJob(request, optionsopt, callbackopt) → {Promise}

Gets the resource representation for a job in a project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
jobId string

Required. The job ID.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const jobId = '';
const request = {
  projectId: projectId,
  region: region,
  jobId: jobId,
};
client.getJob(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

listJobs(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
clusterName string <optional>

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
jobStateMatcher number <optional>

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

The number should be among the values of JobStateMatcher
filter string <optional>

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 = *
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Job.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListJobsResponse.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

// Iterate over all elements.
const projectId = '';
const region = '';
const request = {
  projectId: projectId,
  region: region,
};

client.listJobs(request)
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const projectId = '';
const region = '';
const request = {
  projectId: projectId,
  region: region,
};


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listJobs(nextRequest, options).then(callback);
  }
}
client.listJobs(request, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listJobsStream(request, optionsopt) → {Stream}

Equivalent to listJobs, but returns a NodeJS Stream object.

This fetches the paged responses for listJobs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
clusterName string <optional>

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
jobStateMatcher number <optional>

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

The number should be among the values of JobStateMatcher
filter string <optional>

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 = *
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const request = {
  projectId: projectId,
  region: region,
};
client.listJobsStream(request)
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

submitJob(request, optionsopt, callbackopt) → {Promise}

Submits a job to a cluster.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
job Object

Required. The job resource.

This object should have the same structure as Job
requestId string <optional>

Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests 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.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const job = {};
const request = {
  projectId: projectId,
  region: region,
  job: job,
};
client.submitJob(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

updateJob(request, optionsopt, callbackopt) → {Promise}

Updates a job in a project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the Google Cloud Platform project that the job belongs to.
region string

Required. The Cloud Dataproc region in which to handle the request.
jobId string

Required. The job ID.
job Object

Required. The changes to the job.

This object should have the same structure as Job
updateMask Object

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.

This object should have the same structure as FieldMask
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.JobControllerClient({
  // optional auth parameters.
});

const projectId = '';
const region = '';
const jobId = '';
const job = {};
const updateMask = {};
const request = {
  projectId: projectId,
  region: region,
  jobId: jobId,
  job: job,
  updateMask: updateMask,
};
client.updateJob(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });