Class v4beta1.TenantServiceClient (6.3.1)

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

Package

@google-cloud/talent

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of TenantServiceClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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 TenantServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

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

universeDomain

get universeDomain(): string;

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.

createTenant(request, options)

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

Creates a new tenant entity.

Parameters
Name Description
request 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.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. 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').v4beta1;

  // 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.v4beta1.ICreateTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateTenantRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createTenant(request, callback)

createTenant(request: protos.google.cloud.talent.v4beta1.ICreateTenantRequest, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateTenantRequest
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteTenant(request, options)

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

Deletes specified tenant.

Parameters
Name Description
request 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.v4beta1.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 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 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').v4beta1;

  // 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.v4beta1.IDeleteTenantRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTenantRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteTenant(request, callback)

deleteTenant(request: protos.google.cloud.talent.v4beta1.IDeleteTenantRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTenantRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.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.v4beta1.IGetTenantRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.ITenant,
        protos.google.cloud.talent.v4beta1.IGetTenantRequest | undefined,
        {} | undefined
    ]>;

Retrieves specified tenant.

Parameters
Name Description
request 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.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IGetTenantRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 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').v4beta1;

  // 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.v4beta1.IGetTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IGetTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetTenantRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IGetTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getTenant(request, callback)

getTenant(request: protos.google.cloud.talent.v4beta1.IGetTenantRequest, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IGetTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetTenantRequest
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.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.

listTenants(request, options)

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

Lists all tenants associated with the project.

Parameters
Name Description
request 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.v4beta1.ITenant[], protos.google.cloud.talent.v4beta1.IListTenantsRequest | null, protos.google.cloud.talent.v4beta1.IListTenantsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 for more details and examples.

listTenants(request, options, callback)

listTenants(request: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.talent.v4beta1.IListTenantsRequest, protos.google.cloud.talent.v4beta1.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4beta1.ITenant>): void;
Parameters
Name Description
request IListTenantsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.talent.v4beta1.IListTenantsRequest, protos.google.cloud.talent.v4beta1.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4beta1.ITenant>
Returns
Type Description
void

listTenants(request, callback)

listTenants(request: protos.google.cloud.talent.v4beta1.IListTenantsRequest, callback: PaginationCallback<protos.google.cloud.talent.v4beta1.IListTenantsRequest, protos.google.cloud.talent.v4beta1.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4beta1.ITenant>): void;
Parameters
Name Description
request IListTenantsRequest
callback PaginationCallback<protos.google.cloud.talent.v4beta1.IListTenantsRequest, protos.google.cloud.talent.v4beta1.IListTenantsResponse | null | undefined, protos.google.cloud.talent.v4beta1.ITenant>
Returns
Type Description
void

listTenantsAsync(request, options)

listTenantsAsync(request?: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.talent.v4beta1.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 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.v4beta1.ITenant>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. 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').v4beta1;

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

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

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

  callListTenants();

listTenantsStream(request, options)

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

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

Parameters
Name Description
request 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 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 for more details and examples.

matchCompanyFromProjectCompanyName(projectCompanyName)

matchCompanyFromProjectCompanyName(projectCompanyName: string): string | number;

Parse the company from ProjectCompany resource.

Parameter
Name Description
projectCompanyName string

A fully-qualified path representing project_company resource.
Returns
Type Description
string | number

{string} A string representing the company.

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName)

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the company from ProjectTenantCompany resource.

Parameter
Name Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns
Type Description
string | number

{string} A string representing the company.

matchJobFromProjectJobName(projectJobName)

matchJobFromProjectJobName(projectJobName: string): string | number;

Parse the job from ProjectJob resource.

Parameter
Name Description
projectJobName string

A fully-qualified path representing project_job resource.
Returns
Type Description
string | number

{string} A string representing the job.

matchJobFromProjectTenantJobName(projectTenantJobName)

matchJobFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the job from ProjectTenantJob resource.

Parameter
Name Description
projectTenantJobName string

A fully-qualified path representing project_tenant_job resource.
Returns
Type Description
string | number

{string} A string representing the job.

matchProjectFromProjectCompanyName(projectCompanyName)

matchProjectFromProjectCompanyName(projectCompanyName: string): string | number;

Parse the project from ProjectCompany resource.

Parameter
Name Description
projectCompanyName string

A fully-qualified path representing project_company resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectJobName(projectJobName)

matchProjectFromProjectJobName(projectJobName: string): string | number;

Parse the project from ProjectJob resource.

Parameter
Name Description
projectJobName string

A fully-qualified path representing project_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.

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName)

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the project from ProjectTenantCompany resource.

Parameter
Name Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectTenantJobName(projectTenantJobName)

matchProjectFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the project from ProjectTenantJob resource.

Parameter
Name Description
projectTenantJobName string

A fully-qualified path representing project_tenant_job 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.

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName)

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the tenant from ProjectTenantCompany resource.

Parameter
Name Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns
Type Description
string | number

{string} A string representing the tenant.

matchTenantFromProjectTenantJobName(projectTenantJobName)

matchTenantFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the tenant from ProjectTenantJob resource.

Parameter
Name Description
projectTenantJobName string

A fully-qualified path representing project_tenant_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.

projectCompanyPath(project, company)

projectCompanyPath(project: string, company: string): string;

Return a fully-qualified projectCompany resource name string.

Parameters
Name Description
project string
company string
Returns
Type Description
string

{string} Resource name string.

projectJobPath(project, job)

projectJobPath(project: string, job: string): string;

Return a fully-qualified projectJob resource name string.

Parameters
Name Description
project string
job string
Returns
Type Description
string

{string} Resource name string.

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.

projectTenantCompanyPath(project, tenant, company)

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

Return a fully-qualified projectTenantCompany resource name string.

Parameters
Name Description
project string
tenant string
company string
Returns
Type Description
string

{string} Resource name string.

projectTenantJobPath(project, tenant, job)

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

Return a fully-qualified projectTenantJob resource name string.

Parameters
Name Description
project string
tenant string
job 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.v4beta1.IUpdateTenantRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.ITenant,
        protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | undefined,
        {} | undefined
    ]>;

Updates specified tenant.

Parameters
Name Description
request 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.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 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.v4beta1.UpdateTenantRequest.update_mask 
   *  is provided, only the specified fields in
   *  tenant google.cloud.talent.v4beta1.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.v4beta1.Tenant  are
   *  supported.
   */
  // const updateMask = {}

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

  // 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.v4beta1.IUpdateTenantRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateTenantRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateTenant(request, callback)

updateTenant(request: protos.google.cloud.talent.v4beta1.IUpdateTenantRequest, callback: Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateTenantRequest
callback Callback<protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void