Console
    Contact Us Start free

    Class v4.EventServiceClient (5.1.3)

    A service handles client event report. v4

    Package

    @google-cloud/talent

    Constructors

    (constructor)(opts, gaxInstance)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 , 
  
 gaxInstance 
 ?: 
  
 typeof 
  
 gax 
  
 | 
  
 typeof 
  
 gax 
 . 
 fallback 
 );

    Construct an instance of EventServiceClient.

    Parameters
    Name
    Description
    opts
    ClientOptions
    gaxInstance
    typeof gax | typeof gax.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 EventServiceClient({fallback: 'rest'}, gax); ```

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;

    eventServiceStub

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

    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

    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.

    createClientEvent(request, options)

      createClientEvent 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICreateClientEventRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 IClientEvent 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICreateClientEventRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

    Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools]( https://console.cloud.google.com/talent-solution/overview ). [Learn more]( https://cloud.google.com/talent-solution/docs/management-tools ) about self service tools.

    Parameters
    Name
    Description
    request
    protos. google.cloud.talent.v4.ICreateClientEventRequest

    The request object that will be sent.

    options
    CallOptions

    Call options. See CallOptions for more details.

    Returns
    Type
    Description
    Promise <[ protos. google.cloud.talent.v4.IClientEvent , protos. google.cloud.talent.v4.ICreateClientEventRequest | undefined, {} | undefined ]>

    {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

    Example 
       
 /** 
 * 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 the tenant under which the event is created. 
 *  The format is "projects/{project_id}/tenants/{tenant_id}", for example, 
 *  "projects/foo/tenants/bar". 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. Events issued when end user interacts with customer's application 
 *  that uses Cloud Talent Solution. 
 */ 
  
 // const clientEvent = {} 
  
 // Imports the Talent library 
  
 const 
  
 { 
 EventServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/talent 
' 
 ). 
 v4 
 ; 
  
 // Instantiates a client 
  
 const 
  
 talentClient 
  
 = 
  
 new 
  
  EventServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateClientEvent 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 clientEvent 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 talentClient 
 . 
 createClientEvent 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCreateClientEvent 
 ();

    createClientEvent(request, options, callback)

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

    createClientEvent(request, callback)

      createClientEvent 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICreateClientEventRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 IClientEvent 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4 
 . 
 ICreateClientEventRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name
    Description
    request
    protos. google.cloud.talent.v4.ICreateClientEventRequest
    callback
    Callback <protos. google.cloud.talent.v4.IClientEvent , protos. google.cloud.talent.v4.ICreateClientEventRequest | 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.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: