A service handles auto completion. v4beta1
Package
@google-cloud/talentConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of CompletionClient.
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 CompletionClient({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
;
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.
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.
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.
request
options
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 . Please see the documentation for more details and examples.
/**
* 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 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 = ['abc','def']
/**
* 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
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.talent.v4beta1.ICompleteQueryResponse
, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest
| null | undefined, {} | null | undefined>
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
;
request
callback
Callback
< protos.google.cloud.talent.v4beta1.ICompleteQueryResponse
, protos.google.cloud.talent.v4beta1.ICompleteQueryRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
matchCompanyFromProjectCompanyName(projectCompanyName)
matchCompanyFromProjectCompanyName
(
projectCompanyName
:
string
)
:
string
|
number
;
Parse the company from ProjectCompany resource.
projectCompanyName
string
A fully-qualified path representing project_company resource.
string | number
{string} A string representing the company.
matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName)
matchCompanyFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the company from ProjectTenantCompany resource.
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
string | number
{string} A string representing the company.
matchJobFromProjectJobName(projectJobName)
matchJobFromProjectJobName
(
projectJobName
:
string
)
:
string
|
number
;
Parse the job from ProjectJob resource.
projectJobName
string
A fully-qualified path representing project_job resource.
string | number
{string} A string representing the job.
matchJobFromProjectTenantJobName(projectTenantJobName)
matchJobFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the job from ProjectTenantJob resource.
projectTenantJobName
string
A fully-qualified path representing project_tenant_job resource.
string | number
{string} A string representing the job.
matchProjectFromProjectCompanyName(projectCompanyName)
matchProjectFromProjectCompanyName
(
projectCompanyName
:
string
)
:
string
|
number
;
Parse the project from ProjectCompany resource.
projectCompanyName
string
A fully-qualified path representing project_company resource.
string | number
{string} A string representing the project.
matchProjectFromProjectJobName(projectJobName)
matchProjectFromProjectJobName
(
projectJobName
:
string
)
:
string
|
number
;
Parse the project from ProjectJob resource.
projectJobName
string
A fully-qualified path representing project_job resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromProjectTenantCompanyName(projectTenantCompanyName)
matchProjectFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the project from ProjectTenantCompany resource.
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
string | number
{string} A string representing the project.
matchProjectFromProjectTenantJobName(projectTenantJobName)
matchProjectFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the project from ProjectTenantJob resource.
projectTenantJobName
string
A fully-qualified path representing project_tenant_job resource.
string | number
{string} A string representing the project.
matchProjectFromTenantName(tenantName)
matchProjectFromTenantName
(
tenantName
:
string
)
:
string
|
number
;
Parse the project from Tenant resource.
tenantName
string
A fully-qualified path representing Tenant resource.
string | number
{string} A string representing the project.
matchTenantFromProjectTenantCompanyName(projectTenantCompanyName)
matchTenantFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the tenant from ProjectTenantCompany resource.
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
string | number
{string} A string representing the tenant.
matchTenantFromProjectTenantJobName(projectTenantJobName)
matchTenantFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the tenant from ProjectTenantJob resource.
projectTenantJobName
string
A fully-qualified path representing project_tenant_job resource.
string | number
{string} A string representing the tenant.
matchTenantFromTenantName(tenantName)
matchTenantFromTenantName
(
tenantName
:
string
)
:
string
|
number
;
Parse the tenant from Tenant resource.
tenantName
string
A fully-qualified path representing Tenant resource.
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.
project
string
company
string
string
{string} Resource name string.
projectJobPath(project, job)
projectJobPath
(
project
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified projectJob resource name string.
project
string
job
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
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.
project
string
tenant
string
company
string
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.
project
string
tenant
string
job
string
string
{string} Resource name string.
tenantPath(project, tenant)
tenantPath
(
project
:
string
,
tenant
:
string
)
:
string
;
Return a fully-qualified tenant resource name string.
project
string
tenant
string
string
{string} Resource name string.
