JobControllerClient

The JobController provides methods to manage jobs.

Constructor

new JobControllerClient(optionsopt)

Construct an instance of JobControllerClient.

Parameters:

Name Type Attributes Description

options

object

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

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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.

apiEndpoint

string

The domain name of the API remote host.

Members

(static) apiEndpoint

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

(static) port

The port for this API service.

(static) scopes

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

(static) servicePath

The DNS address for this API service.

Methods

cancelJob(request, optionsopt) → {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 Dataproc region in which to handle the request.
`jobId`	string	Required. The job ID.

options

object

Call options. See CallOptions for more details.

(async) checkSubmitJobAsOperationProgress(name) → {Promise}

Check the status of the long running operation returned by the submitJobAsOperation() method.

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

deleteJob(request, optionsopt) → {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 Dataproc region in which to handle the request.
`jobId`	string	Required. The job ID.

options

object

Call options. See CallOptions for more details.

getJob(request, optionsopt) → {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 Dataproc region in which to handle the request.
`jobId`	string	Required. The job ID.

options

object

Call options. See CallOptions for more details.

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.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

listJobs(request, optionsopt) → {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 Dataproc region in which to handle the request.
`pageSize`	number	<optional>	Optional. The number of results to return in each response.
`pageToken`	string	<optional>	Optional. The page token, returned by a previous call, to request the next page of results.
`clusterName`	string	<optional>	Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
`jobStateMatcher`	google.cloud.dataproc.v1beta2.ListJobsRequest.JobStateMatcher	<optional>	Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If `filter` is provided, `jobStateMatcher` will be ignored.
`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

Call options. See CallOptions for more details.

listJobsAsync(request, optionsopt) → {Object}

Equivalent to listJobs, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

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 Dataproc region in which to handle the request.
`pageSize`	number	<optional>	Optional. The number of results to return in each response.
`pageToken`	string	<optional>	Optional. The page token, returned by a previous call, to request the next page of results.
`clusterName`	string	<optional>	Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
`jobStateMatcher`	google.cloud.dataproc.v1beta2.ListJobsRequest.JobStateMatcher	<optional>	Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If `filter` is provided, `jobStateMatcher` will be ignored.
`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

Call options. See CallOptions for more details.

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 Dataproc region in which to handle the request.
`pageSize`	number	<optional>	Optional. The number of results to return in each response.
`pageToken`	string	<optional>	Optional. The page token, returned by a previous call, to request the next page of results.
`clusterName`	string	<optional>	Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
`jobStateMatcher`	google.cloud.dataproc.v1beta2.ListJobsRequest.JobStateMatcher	<optional>	Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If `filter` is provided, `jobStateMatcher` will be ignored.
`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

Call options. See CallOptions for more details.

See:

https://nodejs.org/api/stream.html

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectLocationAutoscalingPolicyName`	string	A fully-qualified path representing project_location_autoscaling_policy resource.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectRegionAutoscalingPolicyName`	string	A fully-qualified path representing project_region_autoscaling_policy resource.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectLocationAutoscalingPolicyName`	string	A fully-qualified path representing project_location_autoscaling_policy resource.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectLocationWorkflowTemplateName`	string	A fully-qualified path representing project_location_workflow_template resource.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectLocationAutoscalingPolicyName`	string	A fully-qualified path representing project_location_autoscaling_policy resource.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectLocationWorkflowTemplateName`	string	A fully-qualified path representing project_location_workflow_template resource.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectRegionAutoscalingPolicyName`	string	A fully-qualified path representing project_region_autoscaling_policy resource.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectRegionWorkflowTemplateName`	string	A fully-qualified path representing project_region_workflow_template resource.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameters:

Name	Type	Description
`projectRegionAutoscalingPolicyName`	string	A fully-qualified path representing project_region_autoscaling_policy resource.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectRegionWorkflowTemplateName`	string	A fully-qualified path representing project_region_workflow_template resource.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectLocationWorkflowTemplateName`	string	A fully-qualified path representing project_location_workflow_template resource.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameters:

Name	Type	Description
`projectRegionWorkflowTemplateName`	string	A fully-qualified path representing project_region_workflow_template resource.

projectLocationAutoscalingPolicyPath(project, location, autoscaling_policy) → {string}

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`autoscaling_policy`	string

projectLocationWorkflowTemplatePath(project, location, workflow_template) → {string}

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`workflow_template`	string

projectRegionAutoscalingPolicyPath(project, region, autoscaling_policy) → {string}

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters:

Name	Type	Description
`project`	string
`region`	string
`autoscaling_policy`	string

projectRegionWorkflowTemplatePath(project, region, workflow_template) → {string}

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters:

Name	Type	Description
`project`	string
`region`	string
`workflow_template`	string

submitJob(request, optionsopt) → {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 Dataproc region in which to handle the request.
`job`	google.cloud.dataproc.v1beta2.Job		Required. The job resource.
`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

Call options. See CallOptions for more details.

submitJobAsOperation(request, optionsopt) → {Promise}

Submits 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 Dataproc region in which to handle the request.
`job`	google.cloud.dataproc.v1beta2.Job		Required. The job resource.
`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

Call options. See CallOptions for more details.

updateJob(request, optionsopt) → {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 Dataproc region in which to handle the request.
`jobId`	string	Required. The job ID.
`job`	google.cloud.dataproc.v1beta2.Job	Required. The changes to the 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.

options

object

Call options. See CallOptions for more details.