Console
    Contact Us Start free

    Class v4.CompletionClient (3.4.1)

    A service handles auto completion. v4

    Package

    @google-cloud/talent!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of CompletionClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

    Property Value
    Type Description
    string

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    completionStub

      completionStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;
    Property Value
    Type Description
    Promise <{ [name: string]: Function ; }>

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

      innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: Function ; }

    pathTemplates

      pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: gax. PathTemplate ; }

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

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

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    warn

      warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;
    Property Value
    Type Description
    (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.

    companyPath(project, tenant, company)

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

    Return a fully-qualified company resource name string.

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

    {string} Resource name string.

    completeQuery(request, options)

      completeQuery 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICompleteQueryRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICompleteQueryResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICompleteQueryRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.talent.v4.ICompleteQueryRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.talent.v4.ICompleteQueryResponse , protos. google.cloud.talent.v4.ICompleteQueryRequest | undefined, {} | undefined]>

    completeQuery(request, options, callback)

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

    completeQuery(request, callback)

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

    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.

    jobPath(project, tenant, job)

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

    Return a fully-qualified job resource name string.

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

    {string} Resource name string.

    matchCompanyFromCompanyName(companyName)

      matchCompanyFromCompanyName 
 ( 
 companyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the company from Company resource.

    Parameter
    Name Description
    companyName string

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

    {string} A string representing the company.

    matchJobFromJobName(jobName)

      matchJobFromJobName 
 ( 
 jobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the job from Job resource.

    Parameter
    Name Description
    jobName string

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

    {string} A string representing the job.

    matchProjectFromCompanyName(companyName)

      matchProjectFromCompanyName 
 ( 
 companyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Company resource.

    Parameter
    Name Description
    companyName string

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

    {string} A string representing the project.

    matchProjectFromJobName(jobName)

      matchProjectFromJobName 
 ( 
 jobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Job resource.

    Parameter
    Name Description
    jobName string

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

    matchTenantFromCompanyName(companyName)

      matchTenantFromCompanyName 
 ( 
 companyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from Company resource.

    Parameter
    Name Description
    companyName string

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

    {string} A string representing the tenant.

    matchTenantFromJobName(jobName)

      matchTenantFromJobName 
 ( 
 jobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from Job resource.

    Parameter
    Name Description
    jobName string

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

    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: