CompletionClient

A service handles auto completion.

Constructor

new CompletionClient(optionsopt)

Construct an instance of CompletionClient.

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 fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

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

applicationPath(project, tenant, profile, application) → {string}

Return a fully-qualified application resource name string.

Parameters:

Name	Type	Description
`project`	string
`tenant`	string
`profile`	string
`application`	string

Returns:

Type	Description
string	Resource name string.

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.

completeQuery(request, optionsopt) → {Promise}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	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".
`query`	string	Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
`languageCodes`	Array.<string>	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. The maximum number of allowed characters is 255.
`pageSize`	number	Required. Completion result count. The maximum allowed page size is 10.
`company`	string	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".
`scope`	google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope	The scope of the completion. The defaults is CompletionScope.PUBLIC.
`type`	google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType	The completion topic. The default is CompletionType.COMBINED.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing CompleteQueryResponse. Please see the documentation for more details and examples.

Example

const [response] = await client.completeQuery(request);

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.

matchApplicationFromApplicationName(applicationName) → {string}

Parse the application from Application resource.

Parameters:

Name	Type	Description
`applicationName`	string	A fully-qualified path representing Application resource.

Returns:

Type	Description
string	A string representing the application.

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.

matchProfileFromApplicationName(applicationName) → {string}

Parse the profile from Application resource.

Parameters:

Name	Type	Description
`applicationName`	string	A fully-qualified path representing Application resource.

Returns:

Type	Description
string	A string representing the profile.

matchProfileFromProfileName(profileName) → {string}

Parse the profile from Profile resource.

Parameters:

Name	Type	Description
`profileName`	string	A fully-qualified path representing Profile resource.

Returns:

Type	Description
string	A string representing the profile.

matchProjectFromApplicationName(applicationName) → {string}

Parse the project from Application resource.

Parameters:

Name	Type	Description
`applicationName`	string	A fully-qualified path representing Application resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProfileName(profileName) → {string}

Parse the project from Profile resource.

Parameters:

Name	Type	Description
`profileName`	string	A fully-qualified path representing Profile resource.

Returns:

Type	Description
string	A string representing the project.

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.

matchTenantFromApplicationName(applicationName) → {string}

Parse the tenant from Application resource.

Parameters:

Name	Type	Description
`applicationName`	string	A fully-qualified path representing Application resource.

Returns:

Type	Description
string	A string representing the tenant.

matchTenantFromProfileName(profileName) → {string}

Parse the tenant from Profile resource.

Parameters:

Name	Type	Description
`profileName`	string	A fully-qualified path representing Profile resource.

Returns:

Type	Description
string	A string representing the tenant.

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.

profilePath(project, tenant, profile) → {string}

Return a fully-qualified profile resource name string.

Parameters:

Name	Type	Description
`project`	string
`tenant`	string
`profile`	string

Returns:

Type	Description
string	Resource name string.

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.