Class v1.JobControllerClient

The JobController provides methods to manage jobs. v1

Package

@google-cloud/dataproc

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of JobControllerClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

jobControllerStub

jobControllerStub?: Promise<{
        [name: string]: Function;
    }>;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

batchPath(project, location, batch)

batchPath(project: string, location: string, batch: string): string;

Return a fully-qualified batch resource name string.

Parameters
NameDescription
project string
location string
batch string
Returns
TypeDescription
string

{string} Resource name string.

cancelJob(request, options)

cancelJob(request?: protos.google.cloud.dataproc.v1.ICancelJobRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | undefined, {} | undefined]>;

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ICancelJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Job]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job ID.
   */
  // const jobId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callCancelJob() {
    // Construct request
    const request = {
      projectId,
      region,
      jobId,
    };

    // Run request
    const response = await dataprocClient.cancelJob(request);
    console.log(response);
  }

  callCancelJob();

cancelJob(request, options, callback)

cancelJob(request: protos.google.cloud.dataproc.v1.ICancelJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ICancelJobRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelJob(request, callback)

cancelJob(request: protos.google.cloud.dataproc.v1.ICancelJobRequest, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ICancelJobRequest
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ICancelJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkSubmitJobAsOperationProgress(name)

checkSubmitJobAsOperationProgress(name: string): Promise<LROperation<protos.google.cloud.dataproc.v1.Job, protos.google.cloud.dataproc.v1.JobMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dataproc.v1.Job, protos.google.cloud.dataproc.v1.JobMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job resource.
   */
  // const job = {}
  /**
   *  Optional. A unique id used to identify the request. If the server
   *  receives two
   *  SubmitJobRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s
   *  with the same id, then the second request will be ignored and the
   *  first Job google.cloud.dataproc.v1.Job  created and stored in the backend
   *  is returned.
   *  It is recommended to always set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The id must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callSubmitJobAsOperation() {
    // Construct request
    const request = {
      projectId,
      region,
      job,
    };

    // Run request
    const [operation] = await dataprocClient.submitJobAsOperation(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callSubmitJobAsOperation();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

deleteJob(request, options)

deleteJob(request?: protos.google.cloud.dataproc.v1.IDeleteJobRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | undefined, {} | undefined]>;

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

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IDeleteJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job ID.
   */
  // const jobId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callDeleteJob() {
    // Construct request
    const request = {
      projectId,
      region,
      jobId,
    };

    // Run request
    const response = await dataprocClient.deleteJob(request);
    console.log(response);
  }

  callDeleteJob();

deleteJob(request, options, callback)

deleteJob(request: protos.google.cloud.dataproc.v1.IDeleteJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IDeleteJobRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteJob(request, callback)

deleteJob(request: protos.google.cloud.dataproc.v1.IDeleteJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IDeleteJobRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getJob(request, options)

getJob(request?: protos.google.cloud.dataproc.v1.IGetJobRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | undefined, {} | undefined]>;

Gets the resource representation for a job in a project.

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IGetJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Job]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job ID.
   */
  // const jobId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callGetJob() {
    // Construct request
    const request = {
      projectId,
      region,
      jobId,
    };

    // Run request
    const response = await dataprocClient.getJob(request);
    console.log(response);
  }

  callGetJob();

getJob(request, options, callback)

getJob(request: protos.google.cloud.dataproc.v1.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IGetJobRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getJob(request, callback)

getJob(request: protos.google.cloud.dataproc.v1.IGetJobRequest, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IGetJobRequest
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listJobs(request, options)

listJobs(request?: protos.google.cloud.dataproc.v1.IListJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IJob[], protos.google.cloud.dataproc.v1.IListJobsRequest | null, protos.google.cloud.dataproc.v1.IListJobsResponse]>;

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

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dataproc.v1.IJob[], protos.google.cloud.dataproc.v1.IListJobsRequest | null, protos.google.cloud.dataproc.v1.IListJobsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Job]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listJobs(request, options, callback)

listJobs(request: protos.google.cloud.dataproc.v1.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListJobsRequest, protos.google.cloud.dataproc.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataproc.v1.IJob>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IListJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dataproc.v1.IListJobsRequest, protos.google.cloud.dataproc.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataproc.v1.IJob>
Returns
TypeDescription
void

listJobs(request, callback)

listJobs(request: protos.google.cloud.dataproc.v1.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListJobsRequest, protos.google.cloud.dataproc.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataproc.v1.IJob>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IListJobsRequest
callback PaginationCallback<protos.google.cloud.dataproc.v1.IListJobsRequest, protos.google.cloud.dataproc.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataproc.v1.IJob>
Returns
TypeDescription
void

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.cloud.dataproc.v1.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataproc.v1.IJob>;

Equivalent to listJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dataproc.v1.IJob>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Job]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Optional. The number of results to return in each response.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, returned by a previous call, to request the
   *  next page of results.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. If set, the returned jobs list includes only jobs that were
   *  submitted to the named cluster.
   */
  // const clusterName = 'abc123'
  /**
   *  Optional. Specifies enumerated categories of jobs to list.
   *  (default = match ALL jobs).
   *  If `filter` is provided, `jobStateMatcher` will be ignored.
   */
  // const jobStateMatcher = {}
  /**
   *  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 = *
   */
  // const filter = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callListJobs() {
    // Construct request
    const request = {
      projectId,
      region,
    };

    // Run request
    const iterable = await dataprocClient.listJobsAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListJobs();

listJobsStream(request, options)

listJobsStream(request?: protos.google.cloud.dataproc.v1.IListJobsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Job] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameter
NameDescription
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the autoscaling_policy.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameter
NameDescription
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the autoscaling_policy.

matchBatchFromBatchName(batchName)

matchBatchFromBatchName(batchName: string): string | number;

Parse the batch from Batch resource.

Parameter
NameDescription
batchName string

A fully-qualified path representing Batch resource.

Returns
TypeDescription
string | number

{string} A string representing the batch.

matchLocationFromBatchName(batchName)

matchLocationFromBatchName(batchName: string): string | number;

Parse the location from Batch resource.

Parameter
NameDescription
batchName string

A fully-qualified path representing Batch resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameter
NameDescription
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameter
NameDescription
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromBatchName(batchName)

matchProjectFromBatchName(batchName: string): string | number;

Parse the project from Batch resource.

Parameter
NameDescription
batchName string

A fully-qualified path representing Batch resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameter
NameDescription
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameter
NameDescription
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameter
NameDescription
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameter
NameDescription
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameter
NameDescription
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
TypeDescription
string | number

{string} A string representing the region.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameter
NameDescription
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the region.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameter
NameDescription
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the workflow_template.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameter
NameDescription
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.

Returns
TypeDescription
string | number

{string} A string representing the workflow_template.

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

projectLocationAutoscalingPolicyPath(project: string, location: string, autoscalingPolicy: string): string;

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters
NameDescription
project string
location string
autoscalingPolicy string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

projectLocationWorkflowTemplatePath(project: string, location: string, workflowTemplate: string): string;

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters
NameDescription
project string
location string
workflowTemplate string
Returns
TypeDescription
string

{string} Resource name string.

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

projectRegionAutoscalingPolicyPath(project: string, region: string, autoscalingPolicy: string): string;

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters
NameDescription
project string
region string
autoscalingPolicy string
Returns
TypeDescription
string

{string} Resource name string.

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): string;

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters
NameDescription
project string
region string
workflowTemplate string
Returns
TypeDescription
string

{string} Resource name string.

submitJob(request, options)

submitJob(request?: protos.google.cloud.dataproc.v1.ISubmitJobRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | undefined, {} | undefined]>;

Submits a job to a cluster.

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Job]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job resource.
   */
  // const job = {}
  /**
   *  Optional. A unique id used to identify the request. If the server
   *  receives two
   *  SubmitJobRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s
   *  with the same id, then the second request will be ignored and the
   *  first Job google.cloud.dataproc.v1.Job  created and stored in the backend
   *  is returned.
   *  It is recommended to always set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The id must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callSubmitJob() {
    // Construct request
    const request = {
      projectId,
      region,
      job,
    };

    // Run request
    const response = await dataprocClient.submitJob(request);
    console.log(response);
  }

  callSubmitJob();

submitJob(request, options, callback)

submitJob(request: protos.google.cloud.dataproc.v1.ISubmitJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

submitJob(request, callback)

submitJob(request: protos.google.cloud.dataproc.v1.ISubmitJobRequest, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.ISubmitJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

submitJobAsOperation(request, options)

submitJobAsOperation(request?: protos.google.cloud.dataproc.v1.ISubmitJobRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Submits job to a cluster.

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job resource.
   */
  // const job = {}
  /**
   *  Optional. A unique id used to identify the request. If the server
   *  receives two
   *  SubmitJobRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s
   *  with the same id, then the second request will be ignored and the
   *  first Job google.cloud.dataproc.v1.Job  created and stored in the backend
   *  is returned.
   *  It is recommended to always set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The id must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callSubmitJobAsOperation() {
    // Construct request
    const request = {
      projectId,
      region,
      job,
    };

    // Run request
    const [operation] = await dataprocClient.submitJobAsOperation(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callSubmitJobAsOperation();

submitJobAsOperation(request, options, callback)

submitJobAsOperation(request: protos.google.cloud.dataproc.v1.ISubmitJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

submitJobAsOperation(request, callback)

submitJobAsOperation(request: protos.google.cloud.dataproc.v1.ISubmitJobRequest, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.ISubmitJobRequest
callback Callback<LROperation<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IJobMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateJob(request, options)

updateJob(request?: protos.google.cloud.dataproc.v1.IUpdateJobRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | undefined, {} | undefined]>;

Updates a job in a project.

Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IUpdateJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Job]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the Google Cloud Platform project that the job
   *  belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The Dataproc region in which to handle the request.
   */
  // const region = 'us-central1'
  /**
   *  Required. The job ID.
   */
  // const jobId = 'abc123'
  /**
   *  Required. The changes to the job.
   */
  // const job = {}
  /**
   *  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.
   */
  // const updateMask = {}

  // Imports the Dataproc library
  const {JobControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new JobControllerClient();

  async function callUpdateJob() {
    // Construct request
    const request = {
      projectId,
      region,
      jobId,
      job,
      updateMask,
    };

    // Run request
    const response = await dataprocClient.updateJob(request);
    console.log(response);
  }

  callUpdateJob();

updateJob(request, options, callback)

updateJob(request: protos.google.cloud.dataproc.v1.IUpdateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IUpdateJobRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateJob(request, callback)

updateJob(request: protos.google.cloud.dataproc.v1.IUpdateJobRequest, callback: Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dataproc.v1.IUpdateJobRequest
callback Callback<protos.google.cloud.dataproc.v1.IJob, protos.google.cloud.dataproc.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void