Class v4.JobServiceClient

A service handles job management, including job CRUD, enumeration and search. v4

Package

@google-cloud/talent

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of JobServiceClient.

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

jobServiceStub

jobServiceStub?: 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

batchCreateJobs(request, options)

batchCreateJobs(request?: protos.google.cloud.talent.v4.IBatchCreateJobsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Begins executing a batch create jobs operation.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchCreateJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be created.
   *  A maximum of 200 jobs can be created in a batch.
   */
  // const jobs = 1234

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchCreateJobs() {
    // Construct request
    const request = {
      parent,
      jobs,
    };

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

  callBatchCreateJobs();

batchCreateJobs(request, options, callback)

batchCreateJobs(request: protos.google.cloud.talent.v4.IBatchCreateJobsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchCreateJobsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchCreateJobs(request, callback)

batchCreateJobs(request: protos.google.cloud.talent.v4.IBatchCreateJobsRequest, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchCreateJobsRequest
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchCreateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchDeleteJobs(request, options)

batchDeleteJobs(request?: protos.google.cloud.talent.v4.IBatchDeleteJobsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Begins executing a batch delete jobs operation.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchDeleteJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   *  The parent of all of the jobs specified in `names` must match this field.
   */
  // const parent = 'abc123'
  /**
   *  The names of the jobs to delete.
   *  The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}".
   *  For example, "projects/foo/tenants/bar/jobs/baz".
   *  A maximum of 200 jobs can be deleted in a batch.
   */
  // const names = 'abc123'

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchDeleteJobs() {
    // Construct request
    const request = {
      parent,
    };

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

  callBatchDeleteJobs();

batchDeleteJobs(request, options, callback)

batchDeleteJobs(request: protos.google.cloud.talent.v4.IBatchDeleteJobsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchDeleteJobsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchDeleteJobs(request, callback)

batchDeleteJobs(request: protos.google.cloud.talent.v4.IBatchDeleteJobsRequest, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchDeleteJobsRequest
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchDeleteJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchUpdateJobs(request, options)

batchUpdateJobs(request?: protos.google.cloud.talent.v4.IBatchUpdateJobsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Begins executing a batch update jobs operation.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchUpdateJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be updated.
   *  A maximum of 200 jobs can be updated in a batch.
   */
  // const jobs = 1234
  /**
   *  Strongly recommended for the best service experience. Be aware that it will
   *  also increase latency when checking the status of a batch operation.
   *  If update_mask google.cloud.talent.v4.BatchUpdateJobsRequest.update_mask  is provided, only the specified fields in
   *  Job google.cloud.talent.v4.Job  are updated. Otherwise all the fields are updated.
   *  A field mask to restrict the fields that are updated. Only
   *  top level fields of Job google.cloud.talent.v4.Job  are supported.
   *  If update_mask google.cloud.talent.v4.BatchUpdateJobsRequest.update_mask  is provided, The Job google.cloud.talent.v4.Job  inside
   *  JobResult JobOperationResult.JobResult
   *  will only contains fields that is updated, plus the Id of the Job.
   *  Otherwise,  Job google.cloud.talent.v4.Job  will include all fields, which can yield a very
   *  large response.
   */
  // const updateMask = {}

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchUpdateJobs() {
    // Construct request
    const request = {
      parent,
      jobs,
    };

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

  callBatchUpdateJobs();

batchUpdateJobs(request, options, callback)

batchUpdateJobs(request: protos.google.cloud.talent.v4.IBatchUpdateJobsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchUpdateJobsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchUpdateJobs(request, callback)

batchUpdateJobs(request: protos.google.cloud.talent.v4.IBatchUpdateJobsRequest, callback: Callback<LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IBatchUpdateJobsRequest
callback Callback<LROperation<protos.google.cloud.talent.v4.IBatchUpdateJobsResponse, protos.google.cloud.talent.v4.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkBatchCreateJobsProgress(name)

checkBatchCreateJobsProgress(name: string): Promise<LROperation<protos.google.cloud.talent.v4.BatchCreateJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.talent.v4.BatchCreateJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>

{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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be created.
   *  A maximum of 200 jobs can be created in a batch.
   */
  // const jobs = 1234

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchCreateJobs() {
    // Construct request
    const request = {
      parent,
      jobs,
    };

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

  callBatchCreateJobs();

checkBatchDeleteJobsProgress(name)

checkBatchDeleteJobsProgress(name: string): Promise<LROperation<protos.google.cloud.talent.v4.BatchDeleteJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.talent.v4.BatchDeleteJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>

{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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   *  The parent of all of the jobs specified in `names` must match this field.
   */
  // const parent = 'abc123'
  /**
   *  The names of the jobs to delete.
   *  The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}".
   *  For example, "projects/foo/tenants/bar/jobs/baz".
   *  A maximum of 200 jobs can be deleted in a batch.
   */
  // const names = 'abc123'

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchDeleteJobs() {
    // Construct request
    const request = {
      parent,
    };

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

  callBatchDeleteJobs();

checkBatchUpdateJobsProgress(name)

checkBatchUpdateJobsProgress(name: string): Promise<LROperation<protos.google.cloud.talent.v4.BatchUpdateJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.talent.v4.BatchUpdateJobsResponse, protos.google.cloud.talent.v4.BatchOperationMetadata>>

{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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be updated.
   *  A maximum of 200 jobs can be updated in a batch.
   */
  // const jobs = 1234
  /**
   *  Strongly recommended for the best service experience. Be aware that it will
   *  also increase latency when checking the status of a batch operation.
   *  If update_mask google.cloud.talent.v4.BatchUpdateJobsRequest.update_mask  is provided, only the specified fields in
   *  Job google.cloud.talent.v4.Job  are updated. Otherwise all the fields are updated.
   *  A field mask to restrict the fields that are updated. Only
   *  top level fields of Job google.cloud.talent.v4.Job  are supported.
   *  If update_mask google.cloud.talent.v4.BatchUpdateJobsRequest.update_mask  is provided, The Job google.cloud.talent.v4.Job  inside
   *  JobResult JobOperationResult.JobResult
   *  will only contains fields that is updated, plus the Id of the Job.
   *  Otherwise,  Job google.cloud.talent.v4.Job  will include all fields, which can yield a very
   *  large response.
   */
  // const updateMask = {}

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callBatchUpdateJobs() {
    // Construct request
    const request = {
      parent,
      jobs,
    };

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

  callBatchUpdateJobs();

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.

companyPath(project, tenant, company)

companyPath(project: string, tenant: string, company: string): string;

Return a fully-qualified company resource name string.

Parameters
NameDescription
project string
tenant string
company string
Returns
TypeDescription
string

{string} Resource name string.

createJob(request, options)

createJob(request?: protos.google.cloud.talent.v4.ICreateJobRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | undefined, {} | undefined]>;

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

Parameters
NameDescription
request protos.google.cloud.talent.v4.ICreateJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The Job to be created.
   */
  // const job = {}

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callCreateJob() {
    // Construct request
    const request = {
      parent,
      job,
    };

    // Run request
    const response = await talentClient.createJob(request);
    console.log(response);
  }

  callCreateJob();

createJob(request, options, callback)

createJob(request: protos.google.cloud.talent.v4.ICreateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ICreateJobRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createJob(request, callback)

createJob(request: protos.google.cloud.talent.v4.ICreateJobRequest, callback: Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ICreateJobRequest
callback Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.ICreateJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteJob(request, options)

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

Deletes the specified job.

Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.

Parameters
NameDescription
request protos.google.cloud.talent.v4.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.talent.v4.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 resource name of the job to be deleted.
   *  The format is
   *  "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
   *  example, "projects/foo/tenants/bar/jobs/baz".
   */
  // const name = 'abc123'

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callDeleteJob() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteJob();

deleteJob(request, options, callback)

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

deleteJob(request, callback)

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

getJob(request, options)

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

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IGetJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.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 resource name of the job to retrieve.
   *  The format is
   *  "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
   *  example, "projects/foo/tenants/bar/jobs/baz".
   */
  // const name = 'abc123'

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callGetJob() {
    // Construct request
    const request = {
      name,
    };

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

  callGetJob();

getJob(request, options, callback)

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

getJob(request, callback)

getJob(request: protos.google.cloud.talent.v4.IGetJobRequest, callback: Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IGetJobRequest
callback Callback<protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.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.

jobPath(project, tenant, job)

jobPath(project: string, tenant: string, job: string): string;

Return a fully-qualified job resource name string.

Parameters
NameDescription
project string
tenant string
job string
Returns
TypeDescription
string

{string} Resource name string.

listJobs(request, options)

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

Lists jobs by filter.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.IJob[], protos.google.cloud.talent.v4.IListJobsRequest | null, protos.google.cloud.talent.v4.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.talent.v4.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.talent.v4.IListJobsRequest, protos.google.cloud.talent.v4.IListJobsResponse | null | undefined, protos.google.cloud.talent.v4.IJob>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.IListJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.talent.v4.IListJobsRequest, protos.google.cloud.talent.v4.IListJobsResponse | null | undefined, protos.google.cloud.talent.v4.IJob>
Returns
TypeDescription
void

listJobs(request, callback)

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

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.cloud.talent.v4.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.talent.v4.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.talent.v4.IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.talent.v4.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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The filter string specifies the jobs to be enumerated.
   *  Supported operator: =, AND
   *  The fields eligible for filtering are:
   *  * `companyName`
   *  * `requisitionId`
   *  * `status` Available values: OPEN, EXPIRED, ALL. Defaults to
   *  OPEN if no value is specified.
   *  At least one of `companyName` and `requisitionId` must present or an
   *  INVALID_ARGUMENT error is thrown.
   *  Sample Query:
   *  * companyName = "projects/foo/tenants/bar/companies/baz"
   *  * companyName = "projects/foo/tenants/bar/companies/baz" AND
   *  requisitionId = "req-1"
   *  * companyName = "projects/foo/tenants/bar/companies/baz" AND
   *  status = "EXPIRED"
   *  * requisitionId = "req-1"
   *  * requisitionId = "req-1" AND status = "EXPIRED"
   */
  // const filter = 'abc123'
  /**
   *  The starting point of a query result.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of jobs to be returned per page of results.
   *  If job_view google.cloud.talent.v4.ListJobsRequest.job_view is set to JobView.JOB_VIEW_ID_ONLY google.cloud.talent.v4.JobView.JOB_VIEW_ID_ONLY, the maximum allowed
   *  page size is 1000. Otherwise, the maximum allowed page size is 100.
   *  Default is 100 if empty or a number < 1="" is="" specified.="" */="" const="" pagesize="1234" *="" *="" the="" desired="" job="" attributes="" returned="" for="" jobs="" in="" the="" *="" search="" response.="" defaults="" to="" jobview.job_view_full="" google.cloud.talent.v4.jobview.job_view_full="" if="" no="" value="" is="" *="" specified.="" */="" const="" jobview="{}" imports="" the="" talent="" library="" const="" {jobserviceclient}="require('@google-cloud/talent').v4;" instantiates="" a="" client="" const="" talentclient="new" jobserviceclient();="" async="" function="" calllistjobs()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" iterable="await" talentclient.listjobsasync(request);="" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistjobs();="">

listJobsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.talent.v4.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.

matchCompanyFromCompanyName(companyName)

matchCompanyFromCompanyName(companyName: string): string | number;

Parse the company from Company resource.

Parameter
NameDescription
companyName string

A fully-qualified path representing Company resource.

Returns
TypeDescription
string | number

{string} A string representing the company.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchProjectFromCompanyName(companyName)

matchProjectFromCompanyName(companyName: string): string | number;

Parse the project from Company resource.

Parameter
NameDescription
companyName string

A fully-qualified path representing Company resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTenantName(tenantName)

matchProjectFromTenantName(tenantName: string): string | number;

Parse the project from Tenant resource.

Parameter
NameDescription
tenantName string

A fully-qualified path representing Tenant resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchTenantFromCompanyName(companyName)

matchTenantFromCompanyName(companyName: string): string | number;

Parse the tenant from Company resource.

Parameter
NameDescription
companyName string

A fully-qualified path representing Company resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

matchTenantFromJobName(jobName)

matchTenantFromJobName(jobName: string): string | number;

Parse the tenant from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

matchTenantFromTenantName(tenantName)

matchTenantFromTenantName(tenantName: string): string | number;

Parse the tenant from Tenant resource.

Parameter
NameDescription
tenantName string

A fully-qualified path representing Tenant resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

searchJobs(request, options)

searchJobs(request?: protos.google.cloud.talent.v4.ISearchJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | undefined, {} | undefined]>;

Searches for jobs using the provided .

This call constrains the of jobs present in the database, and only returns jobs that the caller has permission to search against.

Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SearchJobsResponse]. 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 resource name of the tenant to search within.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Mode of a search.
   *  Defaults to SearchMode.JOB_SEARCH google.cloud.talent.v4.SearchJobsRequest.SearchMode.JOB_SEARCH.
   */
  // const searchMode = {}
  /**
   *  Required. The meta information collected about the job searcher, used to improve the
   *  search quality of the service. The identifiers (such as `user_id`) are
   *  provided by users, and must be unique and consistent.
   */
  // const requestMetadata = {}
  /**
   *  Query used to search against jobs, such as keyword, location filters, etc.
   */
  // const jobQuery = {}
  /**
   *  Controls whether to broaden the search when it produces sparse results.
   *  Broadened queries append results to the end of the matching results
   *  list.
   *  Defaults to false.
   */
  // const enableBroadening = true
  /**
   *  An expression specifies a histogram request against matching jobs.
   *  Expression syntax is an aggregation function call with histogram facets and
   *  other options.
   *  Available aggregation function calls are:
   *  * `count(string_histogram_facet)`: Count the number of matching entities,
   *  for each distinct attribute value.
   *  * `count(numeric_histogram_facet, list of buckets)`: Count the number of
   *  matching entities within each bucket.
   *  Data types:
   *  * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`.
   *  * String: string like "any string with backslash escape for quote(\")."
   *  * Number: whole number and floating point number like 10, -1 and -0.01.
   *  * List: list of elements with comma(,) separator surrounded by square
   *  brackets, for example, 1, 2, 3 and "one", "two", "three".
   *  Built-in constants:
   *  * MIN (minimum number similar to java Double.MIN_VALUE)
   *  * MAX (maximum number similar to java Double.MAX_VALUE)
   *  Built-in functions:
   *  * bucket(start, end, label): bucket built-in function creates a bucket
   *  with range of start, end). Note that the end is exclusive, for example,
   *  bucket(1, MAX, "positive number") or bucket(1, 10).
   *  Job histogram facets:
   *  * company_display_name: histogram by Job.company_display_name google.cloud.talent.v4.Job.company_display_name.
   *  * employment_type: histogram by Job.employment_types google.cloud.talent.v4.Job.employment_types, for example,
   *    "FULL_TIME", "PART_TIME".
   *  * company_size: histogram by CompanySize google.cloud.talent.v4.CompanySize, for example, "SMALL",
   *  "MEDIUM", "BIG".
   *  * publish_time_in_day: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in days.
   *    Must specify list of numeric buckets in spec.
   *  * publish_time_in_month: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in months.
   *    Must specify list of numeric buckets in spec.
   *  * publish_time_in_year: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in years.
   *    Must specify list of numeric buckets in spec.
   *  * degree_types: histogram by the Job.degree_types google.cloud.talent.v4.Job.degree_types, for example,
   *    "Bachelors", "Masters".
   *  * job_level: histogram by the Job.job_level google.cloud.talent.v4.Job.job_level, for example, "Entry
   *    Level".
   *  * country: histogram by the country code of jobs, for example, "US", "FR".
   *  * admin1: histogram by the admin1 code of jobs, which is a global
   *    placeholder referring to the state, province, or the particular term a
   *    country uses to define the geographic structure below the country level,
   *    for example, "CA", "IL".
   *  * city: histogram by a combination of the "city name, admin1 code". For
   *    example,  "Mountain View, CA", "New York, NY".
   *  * admin1_country: histogram by a combination of the "admin1 code, country",
   *    for example, "CA, US", "IL, US".
   *  * city_coordinate: histogram by the city center's GPS coordinates (latitude
   *    and longitude), for example, 37.4038522,-122.0987765. Since the
   *    coordinates of a city center can change, customers may need to refresh
   *    them periodically.
   *  * locale: histogram by the Job.language_code google.cloud.talent.v4.Job.language_code, for example, "en-US",
   *    "fr-FR".
   *  * language: histogram by the language subtag of the Job.language_code google.cloud.talent.v4.Job.language_code,
   *    for example, "en", "fr".
   *  * category: histogram by the JobCategory google.cloud.talent.v4.JobCategory, for example,
   *    "COMPUTER_AND_IT", "HEALTHCARE".
   *  * base_compensation_unit: histogram by the
   *    CompensationInfo.CompensationUnit google.cloud.talent.v4.CompensationInfo.CompensationUnit  of base
   *    salary, for example, "WEEKLY", "MONTHLY".
   *  * base_compensation: histogram by the base salary. Must specify list of
   *    numeric buckets to group results by.
   *  * annualized_base_compensation: histogram by the base annualized salary.
   *    Must specify list of numeric buckets to group results by.
   *  * annualized_total_compensation: histogram by the total annualized salary.
   *    Must specify list of numeric buckets to group results by.
   *  * string_custom_attribute: histogram by string Job.custom_attributes google.cloud.talent.v4.Job.custom_attributes.
   *    Values can be accessed via square bracket notations like
   *    string_custom_attribute"key1".
   *  * numeric_custom_attribute: histogram by numeric Job.custom_attributes google.cloud.talent.v4.Job.custom_attributes.
   *    Values can be accessed via square bracket notations like
   *    numeric_custom_attribute"key1". Must specify list of numeric buckets to
   *    group results by.
   *  Example expressions:
   *  * `count(admin1)`
   *  * `count(base_compensation, bucket(1000, 10000), bucket(10000, 100000),
   *  bucket(100000, MAX))`
   *  * `count(string_custom_attribute"some-string-custom-attribute")`
   *  * `count(numeric_custom_attribute"some-numeric-custom-attribute",
   *    bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"))`
   */
  // const histogramQueries = 1234
  /**
   *  The desired job attributes returned for jobs in the search response.
   *  Defaults to JobView.JOB_VIEW_SMALL google.cloud.talent.v4.JobView.JOB_VIEW_SMALL  if no value is specified.
   */
  // const jobView = {}
  /**
   *  An integer that specifies the current offset (that is, starting result
   *  location, amongst the jobs deemed by the API as relevant) in search
   *  results. This field is only considered if page_token google.cloud.talent.v4.SearchJobsRequest.page_token  is unset.
   *  The maximum allowed value is 5000. Otherwise an error is thrown.
   *  For example, 0 means to  return results starting from the first matching
   *  job, and 10 means to return from the 11th job. This can be used for
   *  pagination, (for example, pageSize = 10 and offset = 10 means to return
   *  from the second page).
   */
  // const offset = 1234
  /**
   *  A limit on the number of jobs returned in the search results.
   *  Increasing this value above the default value of 10 can increase search
   *  response time. The value can be between 1 and 100.
   */
  // const maxPageSize = 1234
  /**
   *  The token specifying the current offset within
   *  search results. See SearchJobsResponse.next_page_token google.cloud.talent.v4.SearchJobsResponse.next_page_token  for
   *  an explanation of how to obtain the next set of query results.
   */
  // const pageToken = 'abc123'
  /**
   *  The criteria determining how search results are sorted. Default is
   *  `"relevance desc"`.
   *  Supported options are:
   *  * `"relevance desc"`: By relevance descending, as determined by the API
   *    algorithms. Relevance thresholding of query results is only available
   *    with this ordering.
   *  * `"posting_publish_time desc"`: By Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    descending.
   *  * `"posting_update_time desc"`: By Job.posting_update_time google.cloud.talent.v4.Job.posting_update_time
   *    descending.
   *  * `"title"`: By Job.title google.cloud.talent.v4.Job.title  ascending.
   *  * `"title desc"`: By Job.title google.cloud.talent.v4.Job.title  descending.
   *  * `"annualized_base_compensation"`: By job's
   *    CompensationInfo.annualized_base_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_base_compensation_range  ascending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_base_compensation desc"`: By job's
   *    CompensationInfo.annualized_base_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_base_compensation_range  descending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_total_compensation"`: By job's
   *    CompensationInfo.annualized_total_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_total_compensation_range  ascending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_total_compensation desc"`: By job's
   *    CompensationInfo.annualized_total_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_total_compensation_range  descending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"custom_ranking desc"`: By the relevance score adjusted to the
   *    SearchJobsRequest.CustomRankingInfo.ranking_expression google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ranking_expression  with weight
   *    factor assigned by
   *    SearchJobsRequest.CustomRankingInfo.importance_level google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.importance_level  in descending
   *    order.
   *  * Location sorting: Use the special syntax to order jobs by distance:
* `"distance_from('Hawaii')"`: Order by distance from Hawaii.
* `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.
* `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by * multiple locations. See details below.
* `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by * multiple locations. See details below.
* The string can have a maximum of 256 characters. When multiple distance * centers are provided, a job that is close to any of the distance centers * would have a high rank. When a job has multiple locations, the job * location closest to one of the distance centers will be used. Jobs that * don't have locations will be ranked at the bottom. Distance is calculated * with a precision of 11.3 meters (37.4 feet). Diversification strategy is * still applied unless explicitly disabled in * diversification_level google.cloud.talent.v4.SearchJobsRequest.diversification_level. */ // const orderBy = 'abc123' /** * Controls whether highly similar jobs are returned next to each other in * the search results. Jobs are identified as highly similar based on * their titles, job categories, and locations. Highly similar results are * clustered so that only one representative job of the cluster is * displayed to the job seeker higher up in the results, with the other jobs * being displayed lower down in the results. * Defaults to DiversificationLevel.SIMPLE google.cloud.talent.v4.SearchJobsRequest.DiversificationLevel.SIMPLE if no value * is specified. */ // const diversificationLevel = {} /** * Controls over how job documents get ranked on top of existing relevance * score (determined by API algorithm). */ // const customRankingInfo = {} /** * This field is deprecated. Please use * SearchJobsRequest.keyword_match_mode google.cloud.talent.v4.SearchJobsRequest.keyword_match_mode going forward. * To migrate, disable_keyword_match set to false maps to * KeywordMatchMode.KEYWORD_MATCH_ALL google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to * true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_DISABLED. If * SearchJobsRequest.keyword_match_mode google.cloud.talent.v4.SearchJobsRequest.keyword_match_mode is set, this field is ignored. * Controls whether to disable exact keyword match on Job.title google.cloud.talent.v4.Job.title, * Job.description google.cloud.talent.v4.Job.description, Job.company_display_name google.cloud.talent.v4.Job.company_display_name, Job.addresses google.cloud.talent.v4.Job.addresses, * Job.qualifications google.cloud.talent.v4.Job.qualifications. When disable keyword match is turned off, a * keyword match returns jobs that do not match given category filters when * there are matching keywords. For example, for the query "program manager," * a result is returned even if the job posting has the title "software * developer," which doesn't fall into "program manager" ontology, but does * have "program manager" appearing in its description. * For queries like "cloud" that don't contain title or * location specific ontology, jobs with "cloud" keyword matches are returned * regardless of this flag's value. * Use Company.keyword_searchable_job_custom_attributes google.cloud.talent.v4.Company.keyword_searchable_job_custom_attributes if * company-specific globally matched custom field/attribute string values are * needed. Enabling keyword match improves recall of subsequent search * requests. * Defaults to false. */ // const disableKeywordMatch = true /** * Controls what keyword match options to use. If both keyword_match_mode and * disable_keyword_match are set, keyword_match_mode will take precedence. * Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL if no value * is specified. */ // const keywordMatchMode = {} // Imports the Talent library const {JobServiceClient} = require('@google-cloud/talent').v4; // Instantiates a client const talentClient = new JobServiceClient(); async function callSearchJobs() { // Construct request const request = { parent, requestMetadata, }; // Run request const response = await talentClient.searchJobs(request); console.log(response); } callSearchJobs();

searchJobs(request, options, callback)

searchJobs(request: protos.google.cloud.talent.v4.ISearchJobsRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchJobs(request, callback)

searchJobs(request: protos.google.cloud.talent.v4.ISearchJobsRequest, callback: Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest
callback Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchJobsForAlert(request, options)

searchJobsForAlert(request?: protos.google.cloud.talent.v4.ISearchJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | undefined, {} | undefined]>;

Searches for jobs using the provided .

This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), it has different algorithmic adjustments that are designed to specifically target passive job seekers.

This call constrains the of jobs present in the database, and only returns jobs the caller has permission to search against.

Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SearchJobsResponse]. 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 resource name of the tenant to search within.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Mode of a search.
   *  Defaults to SearchMode.JOB_SEARCH google.cloud.talent.v4.SearchJobsRequest.SearchMode.JOB_SEARCH.
   */
  // const searchMode = {}
  /**
   *  Required. The meta information collected about the job searcher, used to improve the
   *  search quality of the service. The identifiers (such as `user_id`) are
   *  provided by users, and must be unique and consistent.
   */
  // const requestMetadata = {}
  /**
   *  Query used to search against jobs, such as keyword, location filters, etc.
   */
  // const jobQuery = {}
  /**
   *  Controls whether to broaden the search when it produces sparse results.
   *  Broadened queries append results to the end of the matching results
   *  list.
   *  Defaults to false.
   */
  // const enableBroadening = true
  /**
   *  An expression specifies a histogram request against matching jobs.
   *  Expression syntax is an aggregation function call with histogram facets and
   *  other options.
   *  Available aggregation function calls are:
   *  * `count(string_histogram_facet)`: Count the number of matching entities,
   *  for each distinct attribute value.
   *  * `count(numeric_histogram_facet, list of buckets)`: Count the number of
   *  matching entities within each bucket.
   *  Data types:
   *  * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`.
   *  * String: string like "any string with backslash escape for quote(\")."
   *  * Number: whole number and floating point number like 10, -1 and -0.01.
   *  * List: list of elements with comma(,) separator surrounded by square
   *  brackets, for example, 1, 2, 3 and "one", "two", "three".
   *  Built-in constants:
   *  * MIN (minimum number similar to java Double.MIN_VALUE)
   *  * MAX (maximum number similar to java Double.MAX_VALUE)
   *  Built-in functions:
   *  * bucket(start, end, label): bucket built-in function creates a bucket
   *  with range of start, end). Note that the end is exclusive, for example,
   *  bucket(1, MAX, "positive number") or bucket(1, 10).
   *  Job histogram facets:
   *  * company_display_name: histogram by Job.company_display_name google.cloud.talent.v4.Job.company_display_name.
   *  * employment_type: histogram by Job.employment_types google.cloud.talent.v4.Job.employment_types, for example,
   *    "FULL_TIME", "PART_TIME".
   *  * company_size: histogram by CompanySize google.cloud.talent.v4.CompanySize, for example, "SMALL",
   *  "MEDIUM", "BIG".
   *  * publish_time_in_day: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in days.
   *    Must specify list of numeric buckets in spec.
   *  * publish_time_in_month: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in months.
   *    Must specify list of numeric buckets in spec.
   *  * publish_time_in_year: histogram by the Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    in years.
   *    Must specify list of numeric buckets in spec.
   *  * degree_types: histogram by the Job.degree_types google.cloud.talent.v4.Job.degree_types, for example,
   *    "Bachelors", "Masters".
   *  * job_level: histogram by the Job.job_level google.cloud.talent.v4.Job.job_level, for example, "Entry
   *    Level".
   *  * country: histogram by the country code of jobs, for example, "US", "FR".
   *  * admin1: histogram by the admin1 code of jobs, which is a global
   *    placeholder referring to the state, province, or the particular term a
   *    country uses to define the geographic structure below the country level,
   *    for example, "CA", "IL".
   *  * city: histogram by a combination of the "city name, admin1 code". For
   *    example,  "Mountain View, CA", "New York, NY".
   *  * admin1_country: histogram by a combination of the "admin1 code, country",
   *    for example, "CA, US", "IL, US".
   *  * city_coordinate: histogram by the city center's GPS coordinates (latitude
   *    and longitude), for example, 37.4038522,-122.0987765. Since the
   *    coordinates of a city center can change, customers may need to refresh
   *    them periodically.
   *  * locale: histogram by the Job.language_code google.cloud.talent.v4.Job.language_code, for example, "en-US",
   *    "fr-FR".
   *  * language: histogram by the language subtag of the Job.language_code google.cloud.talent.v4.Job.language_code,
   *    for example, "en", "fr".
   *  * category: histogram by the JobCategory google.cloud.talent.v4.JobCategory, for example,
   *    "COMPUTER_AND_IT", "HEALTHCARE".
   *  * base_compensation_unit: histogram by the
   *    CompensationInfo.CompensationUnit google.cloud.talent.v4.CompensationInfo.CompensationUnit  of base
   *    salary, for example, "WEEKLY", "MONTHLY".
   *  * base_compensation: histogram by the base salary. Must specify list of
   *    numeric buckets to group results by.
   *  * annualized_base_compensation: histogram by the base annualized salary.
   *    Must specify list of numeric buckets to group results by.
   *  * annualized_total_compensation: histogram by the total annualized salary.
   *    Must specify list of numeric buckets to group results by.
   *  * string_custom_attribute: histogram by string Job.custom_attributes google.cloud.talent.v4.Job.custom_attributes.
   *    Values can be accessed via square bracket notations like
   *    string_custom_attribute"key1".
   *  * numeric_custom_attribute: histogram by numeric Job.custom_attributes google.cloud.talent.v4.Job.custom_attributes.
   *    Values can be accessed via square bracket notations like
   *    numeric_custom_attribute"key1". Must specify list of numeric buckets to
   *    group results by.
   *  Example expressions:
   *  * `count(admin1)`
   *  * `count(base_compensation, bucket(1000, 10000), bucket(10000, 100000),
   *  bucket(100000, MAX))`
   *  * `count(string_custom_attribute"some-string-custom-attribute")`
   *  * `count(numeric_custom_attribute"some-numeric-custom-attribute",
   *    bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"))`
   */
  // const histogramQueries = 1234
  /**
   *  The desired job attributes returned for jobs in the search response.
   *  Defaults to JobView.JOB_VIEW_SMALL google.cloud.talent.v4.JobView.JOB_VIEW_SMALL  if no value is specified.
   */
  // const jobView = {}
  /**
   *  An integer that specifies the current offset (that is, starting result
   *  location, amongst the jobs deemed by the API as relevant) in search
   *  results. This field is only considered if page_token google.cloud.talent.v4.SearchJobsRequest.page_token  is unset.
   *  The maximum allowed value is 5000. Otherwise an error is thrown.
   *  For example, 0 means to  return results starting from the first matching
   *  job, and 10 means to return from the 11th job. This can be used for
   *  pagination, (for example, pageSize = 10 and offset = 10 means to return
   *  from the second page).
   */
  // const offset = 1234
  /**
   *  A limit on the number of jobs returned in the search results.
   *  Increasing this value above the default value of 10 can increase search
   *  response time. The value can be between 1 and 100.
   */
  // const maxPageSize = 1234
  /**
   *  The token specifying the current offset within
   *  search results. See SearchJobsResponse.next_page_token google.cloud.talent.v4.SearchJobsResponse.next_page_token  for
   *  an explanation of how to obtain the next set of query results.
   */
  // const pageToken = 'abc123'
  /**
   *  The criteria determining how search results are sorted. Default is
   *  `"relevance desc"`.
   *  Supported options are:
   *  * `"relevance desc"`: By relevance descending, as determined by the API
   *    algorithms. Relevance thresholding of query results is only available
   *    with this ordering.
   *  * `"posting_publish_time desc"`: By Job.posting_publish_time google.cloud.talent.v4.Job.posting_publish_time
   *    descending.
   *  * `"posting_update_time desc"`: By Job.posting_update_time google.cloud.talent.v4.Job.posting_update_time
   *    descending.
   *  * `"title"`: By Job.title google.cloud.talent.v4.Job.title  ascending.
   *  * `"title desc"`: By Job.title google.cloud.talent.v4.Job.title  descending.
   *  * `"annualized_base_compensation"`: By job's
   *    CompensationInfo.annualized_base_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_base_compensation_range  ascending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_base_compensation desc"`: By job's
   *    CompensationInfo.annualized_base_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_base_compensation_range  descending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_total_compensation"`: By job's
   *    CompensationInfo.annualized_total_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_total_compensation_range  ascending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"annualized_total_compensation desc"`: By job's
   *    CompensationInfo.annualized_total_compensation_range google.cloud.talent.v4.CompensationInfo.annualized_total_compensation_range  descending. Jobs
   *    whose annualized base compensation is unspecified are put at the end of
   *    search results.
   *  * `"custom_ranking desc"`: By the relevance score adjusted to the
   *    SearchJobsRequest.CustomRankingInfo.ranking_expression google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ranking_expression  with weight
   *    factor assigned by
   *    SearchJobsRequest.CustomRankingInfo.importance_level google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.importance_level  in descending
   *    order.
   *  * Location sorting: Use the special syntax to order jobs by distance:
* `"distance_from('Hawaii')"`: Order by distance from Hawaii.
* `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.
* `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by * multiple locations. See details below.
* `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by * multiple locations. See details below.
* The string can have a maximum of 256 characters. When multiple distance * centers are provided, a job that is close to any of the distance centers * would have a high rank. When a job has multiple locations, the job * location closest to one of the distance centers will be used. Jobs that * don't have locations will be ranked at the bottom. Distance is calculated * with a precision of 11.3 meters (37.4 feet). Diversification strategy is * still applied unless explicitly disabled in * diversification_level google.cloud.talent.v4.SearchJobsRequest.diversification_level. */ // const orderBy = 'abc123' /** * Controls whether highly similar jobs are returned next to each other in * the search results. Jobs are identified as highly similar based on * their titles, job categories, and locations. Highly similar results are * clustered so that only one representative job of the cluster is * displayed to the job seeker higher up in the results, with the other jobs * being displayed lower down in the results. * Defaults to DiversificationLevel.SIMPLE google.cloud.talent.v4.SearchJobsRequest.DiversificationLevel.SIMPLE if no value * is specified. */ // const diversificationLevel = {} /** * Controls over how job documents get ranked on top of existing relevance * score (determined by API algorithm). */ // const customRankingInfo = {} /** * This field is deprecated. Please use * SearchJobsRequest.keyword_match_mode google.cloud.talent.v4.SearchJobsRequest.keyword_match_mode going forward. * To migrate, disable_keyword_match set to false maps to * KeywordMatchMode.KEYWORD_MATCH_ALL google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to * true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_DISABLED. If * SearchJobsRequest.keyword_match_mode google.cloud.talent.v4.SearchJobsRequest.keyword_match_mode is set, this field is ignored. * Controls whether to disable exact keyword match on Job.title google.cloud.talent.v4.Job.title, * Job.description google.cloud.talent.v4.Job.description, Job.company_display_name google.cloud.talent.v4.Job.company_display_name, Job.addresses google.cloud.talent.v4.Job.addresses, * Job.qualifications google.cloud.talent.v4.Job.qualifications. When disable keyword match is turned off, a * keyword match returns jobs that do not match given category filters when * there are matching keywords. For example, for the query "program manager," * a result is returned even if the job posting has the title "software * developer," which doesn't fall into "program manager" ontology, but does * have "program manager" appearing in its description. * For queries like "cloud" that don't contain title or * location specific ontology, jobs with "cloud" keyword matches are returned * regardless of this flag's value. * Use Company.keyword_searchable_job_custom_attributes google.cloud.talent.v4.Company.keyword_searchable_job_custom_attributes if * company-specific globally matched custom field/attribute string values are * needed. Enabling keyword match improves recall of subsequent search * requests. * Defaults to false. */ // const disableKeywordMatch = true /** * Controls what keyword match options to use. If both keyword_match_mode and * disable_keyword_match are set, keyword_match_mode will take precedence. * Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL if no value * is specified. */ // const keywordMatchMode = {} // Imports the Talent library const {JobServiceClient} = require('@google-cloud/talent').v4; // Instantiates a client const talentClient = new JobServiceClient(); async function callSearchJobsForAlert() { // Construct request const request = { parent, requestMetadata, }; // Run request const response = await talentClient.searchJobsForAlert(request); console.log(response); } callSearchJobsForAlert();

searchJobsForAlert(request, options, callback)

searchJobsForAlert(request: protos.google.cloud.talent.v4.ISearchJobsRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchJobsForAlert(request, callback)

searchJobsForAlert(request: protos.google.cloud.talent.v4.ISearchJobsRequest, callback: Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4.ISearchJobsRequest
callback Callback<protos.google.cloud.talent.v4.ISearchJobsResponse, protos.google.cloud.talent.v4.ISearchJobsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

tenantPath(project, tenant)

tenantPath(project: string, tenant: string): string;

Return a fully-qualified tenant resource name string.

Parameters
NameDescription
project string
tenant string
Returns
TypeDescription
string

{string} Resource name string.

updateJob(request, options)

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

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Parameters
NameDescription
request protos.google.cloud.talent.v4.IUpdateJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4.IJob, protos.google.cloud.talent.v4.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 Job to be updated.
   */
  // const job = {}
  /**
   *  Strongly recommended for the best service experience.
   *  If update_mask google.cloud.talent.v4.UpdateJobRequest.update_mask  is provided, only the specified fields in
   *  job google.cloud.talent.v4.UpdateJobRequest.job  are updated. Otherwise all the fields are updated.
   *  A field mask to restrict the fields that are updated. Only
   *  top level fields of Job google.cloud.talent.v4.Job  are supported.
   */
  // const updateMask = {}

  // Imports the Talent library
  const {JobServiceClient} = require('@google-cloud/talent').v4;

  // Instantiates a client
  const talentClient = new JobServiceClient();

  async function callUpdateJob() {
    // Construct request
    const request = {
      job,
    };

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

  callUpdateJob();

updateJob(request, options, callback)

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

updateJob(request, callback)

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