JobServiceClient

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

Constructor

new JobServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of JobServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

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

email

string

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

keyFilename

string

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

port

number

The port on which to connect to the remote host.

projectId

string

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

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new JobServiceClient({fallback: true}, gax);

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

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

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

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

callback

function

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkBatchCreateJobsProgress(name) → {Promise}

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

Parameters:

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

Returns:

Type	Description
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 for more details and examples.

Example

  /**
   * 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
   *  is created. For example, "projects/foo".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be created.
   */
  // const jobs = [1,2,3,4]

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

  // 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();

(async) checkBatchUpdateJobsProgress(name) → {Promise}

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

Parameters:

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

Returns:

Type	Description
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 for more details and examples.

Example

  /**
   * 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
   *  is created. For example, "projects/foo".
   */
  // const parent = 'abc123'
  /**
   *  Required. The jobs to be updated.
   */
  // const jobs = [1,2,3,4]
  /**
   *  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.v4beta1.BatchUpdateJobsRequest.update_mask 
   *  is provided, only the specified fields in
   *  Job google.cloud.talent.v4beta1.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.v4beta1.Job  are supported.
   *  If
   *  update_mask google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask 
   *  is provided, The Job google.cloud.talent.v4beta1.Job  inside
   *  JobResult google.cloud.talent.v4beta1.JobOperationResult.JobResult 
   *  will only contains fields that is updated, plus the Id of the Job.
   *  Otherwise,  Job google.cloud.talent.v4beta1.Job  will include all fields,
   *  which can yield a very large response.
   */
  // const updateMask = {}

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

  // 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() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

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

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

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

callback

function

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

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

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

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

callback

function

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

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

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

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listJobsAsync(request, optionsopt) → {Object}

Equivalent to listJobs, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
`filter`	string	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"
`pageToken`	string	The starting point of a query result.
`pageSize`	number	The maximum number of jobs to be returned per page of results. If job_view is set to 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.
`jobView`	google.cloud.talent.v4beta1.JobView	The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * 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 resource name of the tenant under which the job is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
   *  is created. For example, "projects/foo".
   */
  // 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.v4beta1.ListJobsRequest.job_view  is set
   *  to
   *  JobView.JOB_VIEW_ID_ONLY google.cloud.talent.v4beta1.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.v4beta1.JobView.JOB_VIEW_FULL 
   *  if no value is specified.
   */
  // const jobView = {}

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

  // 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, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
`filter`	string	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"
`pageToken`	string	The starting point of a query result.
`pageSize`	number	The maximum number of jobs to be returned per page of results. If job_view is set to 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.
`jobView`	google.cloud.talent.v4beta1.JobView	The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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 for more details and examples.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

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

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

matchCompanyFromProjectCompanyName(projectCompanyName) → {string}

Parse the company from ProjectCompany resource.

Parameters:

Name	Type	Description
`projectCompanyName`	string	A fully-qualified path representing project_company resource.

Returns:

Type	Description
string	A string representing the company.

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the company from ProjectTenantCompany resource.

Parameters:

Name	Type	Description
`projectTenantCompanyName`	string	A fully-qualified path representing project_tenant_company resource.

Returns:

Type	Description
string	A string representing the company.

matchJobFromProjectJobName(projectJobName) → {string}

Parse the job from ProjectJob resource.

Parameters:

Name	Type	Description
`projectJobName`	string	A fully-qualified path representing project_job resource.

Returns:

Type	Description
string	A string representing the job.

matchJobFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the job from ProjectTenantJob resource.

Parameters:

Name	Type	Description
`projectTenantJobName`	string	A fully-qualified path representing project_tenant_job resource.

Returns:

Type	Description
string	A string representing the job.

matchProjectFromProjectCompanyName(projectCompanyName) → {string}

Parse the project from ProjectCompany resource.

Parameters:

Name	Type	Description
`projectCompanyName`	string	A fully-qualified path representing project_company resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectJobName(projectJobName) → {string}

Parse the project from ProjectJob resource.

Parameters:

Name	Type	Description
`projectJobName`	string	A fully-qualified path representing project_job resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the project from ProjectTenantCompany resource.

Parameters:

Name	Type	Description
`projectTenantCompanyName`	string	A fully-qualified path representing project_tenant_company resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the project from ProjectTenantJob resource.

Parameters:

Name	Type	Description
`projectTenantJobName`	string	A fully-qualified path representing project_tenant_job resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTenantName(tenantName) → {string}

Parse the project from Tenant resource.

Parameters:

Name	Type	Description
`tenantName`	string	A fully-qualified path representing Tenant resource.

Returns:

Type	Description
string	A string representing the project.

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the tenant from ProjectTenantCompany resource.

Parameters:

Name	Type	Description
`projectTenantCompanyName`	string	A fully-qualified path representing project_tenant_company resource.

Returns:

Type	Description
string	A string representing the tenant.

matchTenantFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the tenant from ProjectTenantJob resource.

Parameters:

Name	Type	Description
`projectTenantJobName`	string	A fully-qualified path representing project_tenant_job resource.

Returns:

Type	Description
string	A string representing the tenant.

matchTenantFromTenantName(tenantName) → {string}

Parse the tenant from Tenant resource.

Parameters:

Name	Type	Description
`tenantName`	string	A fully-qualified path representing Tenant resource.

Returns:

Type	Description
string	A string representing the tenant.

projectCompanyPath(project, company) → {string}

Return a fully-qualified projectCompany resource name string.

Parameters:

Name	Type	Description
`project`	string
`company`	string

Returns:

Type	Description
string	Resource name string.

projectJobPath(project, job) → {string}

Return a fully-qualified projectJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`job`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectTenantCompanyPath(project, tenant, company) → {string}

Return a fully-qualified projectTenantCompany resource name string.

Parameters:

Name	Type	Description
`project`	string
`tenant`	string
`company`	string

Returns:

Type	Description
string	Resource name string.

projectTenantJobPath(project, tenant, job) → {string}

Return a fully-qualified projectTenantJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`tenant`	string
`job`	string

Returns:

Type	Description
string	Resource name string.

tenantPath(project, tenant) → {string}

Return a fully-qualified tenant resource name string.

Parameters:

Name	Type	Description
`project`	string
`tenant`	string

Returns:

Type	Description
string	Resource name string.