CompletionClient

CompletionClient

A service handles auto completion.

Constructor

new CompletionClient(optionsopt)

Construct an instance of CompletionClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 <optional>

The port on which to connect to the remote host.
projectId string <optional>

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.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

companyPath(project, tenant, company) → {String}

Return a fully-qualified company resource name string.

Parameters:
Name Type Description
project String
tenant String
company String
Source:

companyWithoutTenantPath(project, company) → {String}

Return a fully-qualified company_without_tenant resource name string.

Parameters:
Name Type Description
project String
company String
Source:

completeQuery(request, optionsopt, callbackopt) → {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 Attributes 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.
pageSize number

Required. Completion result count.

The maximum allowed page size is 10.
languageCodes Array.<string> <optional>

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.
company string <optional>

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 number <optional>

The scope of the completion. The defaults is CompletionScope.PUBLIC.

The number should be among the values of CompletionScope
type number <optional>

The completion topic. The default is CompletionType.COMBINED.

The number should be among the values of CompletionType
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing CompleteQueryResponse.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.CompletionClient({
  // optional auth parameters.
});

const formattedParent = client.tenantPath('[PROJECT]', '[TENANT]');
const query = '';
const pageSize = 0;
const request = {
  parent: formattedParent,
  query: query,
  pageSize: pageSize,
};
client.completeQuery(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

matchCompanyFromCompanyName(companyName) → {String}

Parse the companyName from a company resource.

Parameters:
Name Type Description
companyName String

A fully-qualified path representing a company resources.
Source:

matchCompanyFromCompanyWithoutTenantName(companyWithoutTenantName) → {String}

Parse the companyWithoutTenantName from a company_without_tenant resource.

Parameters:
Name Type Description
companyWithoutTenantName String

A fully-qualified path representing a company_without_tenant resources.
Source:

matchProjectFromCompanyName(companyName) → {String}

Parse the companyName from a company resource.

Parameters:
Name Type Description
companyName String

A fully-qualified path representing a company resources.
Source:

matchProjectFromCompanyWithoutTenantName(companyWithoutTenantName) → {String}

Parse the companyWithoutTenantName from a company_without_tenant resource.

Parameters:
Name Type Description
companyWithoutTenantName String

A fully-qualified path representing a company_without_tenant resources.
Source:

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

matchProjectFromTenantName(tenantName) → {String}

Parse the tenantName from a tenant resource.

Parameters:
Name Type Description
tenantName String

A fully-qualified path representing a tenant resources.
Source:

matchTenantFromCompanyName(companyName) → {String}

Parse the companyName from a company resource.

Parameters:
Name Type Description
companyName String

A fully-qualified path representing a company resources.
Source:

matchTenantFromTenantName(tenantName) → {String}

Parse the tenantName from a tenant resource.

Parameters:
Name Type Description
tenantName String

A fully-qualified path representing a tenant resources.
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

tenantPath(project, tenant) → {String}

Return a fully-qualified tenant resource name string.

Parameters:
Name Type Description
project String
tenant String
Source: