Class v4beta1.CompletionClient

A service handles auto completion. v4beta1

Package

@google-cloud/talent

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CompletionClient.

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;

completionStub

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

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.

warn

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

Methods

applicationPath(project, tenant, profile, application)

applicationPath(project: string, tenant: string, profile: string, application: string): string;

Return a fully-qualified application resource name string.

Parameters
NameDescription
project string
tenant string
profile string
application string
Returns
TypeDescription
string

{string} Resource name string.

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.

completeQuery(request, options)

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

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

Parameters
NameDescription
request protos.google.cloud.talent.v4beta1.ICompleteQueryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.talent.v4beta1.ICompleteQueryResponse, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [CompleteQueryResponse]. 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 tenant the completion is performed within.
   *  The format is "projects/{project_id}/tenants/{tenant_id}", for example,
   *  "projects/foo/tenant/bar".
   *  If tenant id is unspecified, the default tenant is used, for
   *  example, "projects/foo".
   */
  // const parent = 'abc123'
  /**
   *  Required. The query used to generate suggestions.
   *  The maximum number of allowed characters is 255.
   */
  // const query = 'abc123'
  /**
   *  The list of languages of the query. This is
   *  the BCP-47 language code, such as "en-US" or "sr-Latn".
   *  For more information, see
   *  Tags for Identifying Languages (https://tools.ietf.org/html/bcp47).
   *  The maximum number of allowed characters is 255.
   */
  // const languageCodes = 'abc123'
  /**
   *  Required. Completion result count.
   *  The maximum allowed page size is 10.
   */
  // const pageSize = 1234
  /**
   *  If provided, restricts completion to specified company.
   *  The format is
   *  "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
   *  example, "projects/foo/tenants/bar/companies/baz".
   *  If tenant id is unspecified, the default tenant is used, for
   *  example, "projects/foo".
   */
  // const company = 'abc123'
  /**
   *  The scope of the completion. The defaults is CompletionScope.PUBLIC google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope.PUBLIC.
   */
  // const scope = {}
  /**
   *  The completion topic. The default is CompletionType.COMBINED google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED.
   */
  // const type = {}

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

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

  async function callCompleteQuery() {
    // Construct request
    const request = {
      parent,
      query,
      pageSize,
    };

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

  callCompleteQuery();

completeQuery(request, options, callback)

completeQuery(request: protos.google.cloud.talent.v4beta1.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.ICompleteQueryResponse, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4beta1.ICompleteQueryRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4beta1.ICompleteQueryResponse, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

completeQuery(request, callback)

completeQuery(request: protos.google.cloud.talent.v4beta1.ICompleteQueryRequest, callback: Callback<protos.google.cloud.talent.v4beta1.ICompleteQueryResponse, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.talent.v4beta1.ICompleteQueryRequest
callback Callback<protos.google.cloud.talent.v4beta1.ICompleteQueryResponse, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest | 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.

matchApplicationFromApplicationName(applicationName)

matchApplicationFromApplicationName(applicationName: string): string | number;

Parse the application from Application resource.

Parameter
NameDescription
applicationName string

A fully-qualified path representing Application resource.

Returns
TypeDescription
string | number

{string} A string representing the application.

matchCompanyFromProjectCompanyName(projectCompanyName)

matchCompanyFromProjectCompanyName(projectCompanyName: string): string | number;

Parse the company from ProjectCompany resource.

Parameter
NameDescription
projectCompanyName string

A fully-qualified path representing project_company resource.

Returns
TypeDescription
string | number

{string} A string representing the company.

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName)

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the company from ProjectTenantCompany resource.

Parameter
NameDescription
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.

Returns
TypeDescription
string | number

{string} A string representing the company.

matchJobFromProjectJobName(projectJobName)

matchJobFromProjectJobName(projectJobName: string): string | number;

Parse the job from ProjectJob resource.

Parameter
NameDescription
projectJobName string

A fully-qualified path representing project_job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchJobFromProjectTenantJobName(projectTenantJobName)

matchJobFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the job from ProjectTenantJob resource.

Parameter
NameDescription
projectTenantJobName string

A fully-qualified path representing project_tenant_job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchProfileFromApplicationName(applicationName)

matchProfileFromApplicationName(applicationName: string): string | number;

Parse the profile from Application resource.

Parameter
NameDescription
applicationName string

A fully-qualified path representing Application resource.

Returns
TypeDescription
string | number

{string} A string representing the profile.

matchProfileFromProfileName(profileName)

matchProfileFromProfileName(profileName: string): string | number;

Parse the profile from Profile resource.

Parameter
NameDescription
profileName string

A fully-qualified path representing Profile resource.

Returns
TypeDescription
string | number

{string} A string representing the profile.

matchProjectFromApplicationName(applicationName)

matchProjectFromApplicationName(applicationName: string): string | number;

Parse the project from Application resource.

Parameter
NameDescription
applicationName string

A fully-qualified path representing Application resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProfileName(profileName)

matchProjectFromProfileName(profileName: string): string | number;

Parse the project from Profile resource.

Parameter
NameDescription
profileName string

A fully-qualified path representing Profile resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectCompanyName(projectCompanyName)

matchProjectFromProjectCompanyName(projectCompanyName: string): string | number;

Parse the project from ProjectCompany resource.

Parameter
NameDescription
projectCompanyName string

A fully-qualified path representing project_company resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectJobName(projectJobName)

matchProjectFromProjectJobName(projectJobName: string): string | number;

Parse the project from ProjectJob resource.

Parameter
NameDescription
projectJobName string

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

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName)

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the project from ProjectTenantCompany resource.

Parameter
NameDescription
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectTenantJobName(projectTenantJobName)

matchProjectFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the project from ProjectTenantJob resource.

Parameter
NameDescription
projectTenantJobName string

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

matchTenantFromApplicationName(applicationName)

matchTenantFromApplicationName(applicationName: string): string | number;

Parse the tenant from Application resource.

Parameter
NameDescription
applicationName string

A fully-qualified path representing Application resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

matchTenantFromProfileName(profileName)

matchTenantFromProfileName(profileName: string): string | number;

Parse the tenant from Profile resource.

Parameter
NameDescription
profileName string

A fully-qualified path representing Profile resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName)

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number;

Parse the tenant from ProjectTenantCompany resource.

Parameter
NameDescription
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.

Returns
TypeDescription
string | number

{string} A string representing the tenant.

matchTenantFromProjectTenantJobName(projectTenantJobName)

matchTenantFromProjectTenantJobName(projectTenantJobName: string): string | number;

Parse the tenant from ProjectTenantJob resource.

Parameter
NameDescription
projectTenantJobName string

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

profilePath(project, tenant, profile)

profilePath(project: string, tenant: string, profile: string): string;

Return a fully-qualified profile resource name string.

Parameters
NameDescription
project string
tenant string
profile string
Returns
TypeDescription
string

{string} Resource name string.

projectCompanyPath(project, company)

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

Return a fully-qualified projectCompany resource name string.

Parameters
NameDescription
project string
company string
Returns
TypeDescription
string

{string} Resource name string.

projectJobPath(project, job)

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

Return a fully-qualified projectJob resource name string.

Parameters
NameDescription
project string
job string
Returns
TypeDescription
string

{string} Resource name string.

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.

projectTenantCompanyPath(project, tenant, company)

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

Return a fully-qualified projectTenantCompany resource name string.

Parameters
NameDescription
project string
tenant string
company string
Returns
TypeDescription
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
NameDescription
project string
tenant string
job string
Returns
TypeDescription
string

{string} Resource name string.

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.