Class v4.TenantServiceClient (3.5.1)

A service that handles tenant management, including CRUD and enumeration. v4

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of TenantServiceClient.

Parameter

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

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.

tenantServiceStub

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

warn

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

Methods

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

Type	Description
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

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

Returns

Type	Description
string	{string} Resource name string.

createTenant(request, options)

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

Creates a new tenant entity.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.ICreateTenantRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.ICreateTenantRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tenant]. 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. Resource name of the project under which the tenant is created.
   *  The format is "projects/{project_id}", for example,
   *  "projects/foo".
   */
  // const parent = 'abc123'
  /**
   *  Required. The tenant to be created.
   */
  // const tenant = {}

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

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

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

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

  callCreateTenant();

createTenant(request, options, callback)

createTenant(request: protos.google.cloud.talent.v4.ICreateTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.ICreateTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.ICreateTenantRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.ICreateTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createTenant(request, callback)

createTenant(request: protos.google.cloud.talent.v4.ICreateTenantRequest, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.ICreateTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.ICreateTenantRequest`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.ICreateTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteTenant(request, options)

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

Deletes specified tenant.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IDeleteTenantRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteTenantRequest \| 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 tenant to be deleted.
   *  The format is "projects/{project_id}/tenants/{tenant_id}", for example,
   *  "projects/foo/tenants/bar".
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTenant();

deleteTenant(request, options, callback)

deleteTenant(request: protos.google.cloud.talent.v4.IDeleteTenantRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IDeleteTenantRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteTenant(request, callback)

deleteTenant(request: protos.google.cloud.talent.v4.IDeleteTenantRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IDeleteTenantRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

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

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

getTenant(request, options)

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

Retrieves specified tenant.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IGetTenantRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IGetTenantRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tenant]. 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 be retrieved.
   *  The format is "projects/{project_id}/tenants/{tenant_id}", for example,
   *  "projects/foo/tenants/bar".
   */
  // const name = 'abc123'

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

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

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

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

  callGetTenant();

getTenant(request, options, callback)

getTenant(request: protos.google.cloud.talent.v4.IGetTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IGetTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IGetTenantRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IGetTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getTenant(request, callback)

getTenant(request: protos.google.cloud.talent.v4.IGetTenantRequest, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IGetTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IGetTenantRequest`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IGetTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
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

Type	Description
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

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

Returns

Type	Description
string	{string} Resource name string.

listTenants(request, options)

listTenants(request?: protos.google.cloud.talent.v4.IListTenantsRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ITenant[], protos.google.cloud.talent.v4.IListTenantsRequest | null, protos.google.cloud.talent.v4.IListTenantsResponse]>;

Lists all tenants associated with the project.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IListTenantsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[protos.google.cloud.talent.v4.ITenant[], protos.google.cloud.talent.v4.IListTenantsRequest | null, protos.google.cloud.talent.v4.IListTenantsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Tenant]. 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 listTenantsAsync() 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.

listTenants(request, options, callback)

listTenants(request: protos.google.cloud.talent.v4.IListTenantsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.talent.v4.IListTenantsRequest, protos.google.cloud.talent.v4.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4.ITenant>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IListTenantsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.talent.v4.IListTenantsRequest, protos.google.cloud.talent.v4.IListTenantsResponse \| null \| undefined, protos.google.cloud.talent.v4.ITenant>`

Returns

Type	Description
void

listTenants(request, callback)

listTenants(request: protos.google.cloud.talent.v4.IListTenantsRequest, callback: PaginationCallback<protos.google.cloud.talent.v4.IListTenantsRequest, protos.google.cloud.talent.v4.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4.ITenant>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IListTenantsRequest`
callback	`PaginationCallback<protos.google.cloud.talent.v4.IListTenantsRequest, protos.google.cloud.talent.v4.IListTenantsResponse \| null \| undefined, protos.google.cloud.talent.v4.ITenant>`

Returns

Type	Description
void

listTenantsAsync(request, options)

listTenantsAsync(request?: protos.google.cloud.talent.v4.IListTenantsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.talent.v4.ITenant>;

Equivalent to listTenants, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IListTenantsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.talent.v4.ITenant>

{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 [Tenant]. 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. Resource name of the project under which the tenant is created.
   *  The format is "projects/{project_id}", for example,
   *  "projects/foo".
   */
  // const parent = 'abc123'
  /**
   *  The starting indicator from which to return results.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of tenants to be returned, at most 100.
   *  Default is 100 if a non-positive number is provided.
   */
  // const pageSize = 1234

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

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

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

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

  callListTenants();

listTenantsStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IListTenantsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Tenant] 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 listTenantsAsync() 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

Name	Description
companyName	`string` A fully-qualified path representing Company resource.

Returns

Type	Description
string \| number	{string} A string representing the company.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter

Name	Description
jobName	`string` A fully-qualified path representing Job resource.

Returns

Type	Description
string \| number	{string} A string representing the job.

matchProjectFromCompanyName(companyName)

matchProjectFromCompanyName(companyName: string): string | number;

Parse the project from Company resource.

Parameter

Name	Description
companyName	`string` A fully-qualified path representing Company resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter

Name	Description
jobName	`string` A fully-qualified path representing Job resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTenantName(tenantName)

matchProjectFromTenantName(tenantName: string): string | number;

Parse the project from Tenant resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the project.

matchTenantFromCompanyName(companyName)

matchTenantFromCompanyName(companyName: string): string | number;

Parse the tenant from Company resource.

Parameter

Name	Description
companyName	`string` A fully-qualified path representing Company resource.

Returns

Type	Description
string \| number	{string} A string representing the tenant.

matchTenantFromJobName(jobName)

matchTenantFromJobName(jobName: string): string | number;

Parse the tenant from Job resource.

Parameter

Name	Description
jobName	`string` A fully-qualified path representing Job resource.

Returns

Type	Description
string \| number	{string} A string representing the tenant.

matchTenantFromTenantName(tenantName)

matchTenantFromTenantName(tenantName: string): string | number;

Parse the tenant from Tenant resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the tenant.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

tenantPath(project, tenant)

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

Return a fully-qualified tenant resource name string.

Parameters

Name	Description
project	`string`
tenant	`string`

Returns

Type	Description
string	{string} Resource name string.

updateTenant(request, options)

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

Updates specified tenant.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IUpdateTenantRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IUpdateTenantRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tenant]. 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 tenant resource to replace the current resource in the system.
   */
  // const tenant = {}
  /**
   *  Strongly recommended for the best service experience.
   *  If update_mask google.cloud.talent.v4.UpdateTenantRequest.update_mask  is provided, only the specified fields in
   *  tenant google.cloud.talent.v4.UpdateTenantRequest.tenant  are updated. Otherwise all the fields are updated.
   *  A field mask to specify the tenant fields to be updated. Only
   *  top level fields of Tenant google.cloud.talent.v4.Tenant  are supported.
   */
  // const updateMask = {}

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

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

  async function callUpdateTenant() {
    // Construct request
    const request = {
      tenant,
    };

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

  callUpdateTenant();

updateTenant(request, options, callback)

updateTenant(request: protos.google.cloud.talent.v4.IUpdateTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IUpdateTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IUpdateTenantRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IUpdateTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateTenant(request, callback)

updateTenant(request: protos.google.cloud.talent.v4.IUpdateTenantRequest, callback: Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IUpdateTenantRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4.IUpdateTenantRequest`
callback	`Callback<protos.google.cloud.talent.v4.ITenant, protos.google.cloud.talent.v4.IUpdateTenantRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void