Class v1.JobControllerClient (4.1.1)

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Properties

apiEndpoint

static get apiEndpoint(): string;

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;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

Methods

batchPath(project, location, batch)

batchPath(project: string, location: string, batch: string): 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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;

checkSubmitJobAsOperationProgress(name)

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

  /**
   * This snippet 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.
   * 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>;

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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;

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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

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

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
    ]>;

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;

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;

listJobsAsync(request, options)

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

  /**
   * This snippet 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.
   * 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;

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchBatchFromBatchName(batchName)

matchBatchFromBatchName(batchName: string): string | number;

matchLocationFromBatchName(batchName)

matchLocationFromBatchName(batchName: string): string | number;

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchProjectFromBatchName(batchName)

matchProjectFromBatchName(batchName: string): string | number;

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

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

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

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

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

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

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): 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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;

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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;

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
    ]>;

  /**
   * This snippet 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.
   * 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;

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;