Console
    Contact Us Start free

    Class v4beta1.EventServiceClient (4.1.1)

    A service handles client event report. v4beta1

    Package

    @google-cloud/talent

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of EventServiceClient.

    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.

    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

    applicationPath(project, tenant, profile, application)

      applicationPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 tenant 
 : 
  
 string 
 , 
  
 profile 
 : 
  
 string 
 , 
  
 application 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified application resource name string.

    Parameters
    Name Description
    project string
    tenant string
    profile string
    application string
    Returns
    Type Description
    string

    {string} Resource name string.

    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.

    createClientEvent(request, options)

      createClientEvent 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 ICreateClientEventRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 IClientEvent 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 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.v4beta1.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.v4beta1.IClientEvent , protos. google.cloud.talent.v4beta1.ICreateClientEventRequest | undefined, {} | undefined ]>

    {Promise} - The promise which resolves to an array. The first element of the array is an object representing [ClientEvent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
    Example 
       
 /** 
 * 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/tenant/bar". If tenant id is unspecified, a default tenant 
 *  is created, for example, "projects/foo". 
 */ 
  
 // 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 
' 
 ). 
 v4beta1 
 ; 
  
 // 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 
 . 
 v4beta1 
 . 
 ICreateClientEventRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 IClientEvent 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 ICreateClientEventRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.talent.v4beta1.ICreateClientEventRequest
    options CallOptions
    callback Callback <protos. google.cloud.talent.v4beta1.IClientEvent , protos. google.cloud.talent.v4beta1.ICreateClientEventRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    createClientEvent(request, callback)

      createClientEvent 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 ICreateClientEventRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 IClientEvent 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 talent 
 . 
 v4beta1 
 . 
 ICreateClientEventRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.talent.v4beta1.ICreateClientEventRequest
    callback Callback <protos. google.cloud.talent.v4beta1.IClientEvent , protos. google.cloud.talent.v4beta1.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.

    matchApplicationFromApplicationName(applicationName)

      matchApplicationFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the application from Application resource.

    Parameter
    Name Description
    applicationName string

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

    {string} A string representing the application.

    matchCompanyFromProjectCompanyName(projectCompanyName)

      matchCompanyFromProjectCompanyName 
 ( 
 projectCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the company from ProjectCompany resource.

    Parameter
    Name Description
    projectCompanyName string

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

    {string} A string representing the company.

    matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName)

      matchCompanyFromProjectTenantCompanyName 
 ( 
 projectTenantCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the company from ProjectTenantCompany resource.

    Parameter
    Name Description
    projectTenantCompanyName string

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

    {string} A string representing the company.

    matchJobFromProjectJobName(projectJobName)

      matchJobFromProjectJobName 
 ( 
 projectJobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the job from ProjectJob resource.

    Parameter
    Name Description
    projectJobName string

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

    {string} A string representing the job.

    matchJobFromProjectTenantJobName(projectTenantJobName)

      matchJobFromProjectTenantJobName 
 ( 
 projectTenantJobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the job from ProjectTenantJob resource.

    Parameter
    Name Description
    projectTenantJobName string

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

    {string} A string representing the job.

    matchProfileFromApplicationName(applicationName)

      matchProfileFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the profile from Application resource.

    Parameter
    Name Description
    applicationName string

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

    {string} A string representing the profile.

    matchProfileFromProfileName(profileName)

      matchProfileFromProfileName 
 ( 
 profileName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the profile from Profile resource.

    Parameter
    Name Description
    profileName string

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

    {string} A string representing the profile.

    matchProjectFromApplicationName(applicationName)

      matchProjectFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Application resource.

    Parameter
    Name Description
    applicationName string

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

    {string} A string representing the project.

    matchProjectFromProfileName(profileName)

      matchProjectFromProfileName 
 ( 
 profileName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Profile resource.

    Parameter
    Name Description
    profileName string

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

    {string} A string representing the project.

    matchProjectFromProjectCompanyName(projectCompanyName)

      matchProjectFromProjectCompanyName 
 ( 
 projectCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectCompany resource.

    Parameter
    Name Description
    projectCompanyName string

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

    {string} A string representing the project.

    matchProjectFromProjectJobName(projectJobName)

      matchProjectFromProjectJobName 
 ( 
 projectJobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectJob resource.

    Parameter
    Name Description
    projectJobName string

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

    {string} A string representing the project.

    matchProjectFromProjectName(projectName)

      matchProjectFromProjectName 
 ( 
 projectName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Project resource.

    Parameter
    Name Description
    projectName string

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

    {string} A string representing the project.

    matchProjectFromProjectTenantCompanyName(projectTenantCompanyName)

      matchProjectFromProjectTenantCompanyName 
 ( 
 projectTenantCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectTenantCompany resource.

    Parameter
    Name Description
    projectTenantCompanyName string

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

    {string} A string representing the project.

    matchProjectFromProjectTenantJobName(projectTenantJobName)

      matchProjectFromProjectTenantJobName 
 ( 
 projectTenantJobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectTenantJob resource.

    Parameter
    Name Description
    projectTenantJobName string

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

    matchTenantFromApplicationName(applicationName)

      matchTenantFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from Application resource.

    Parameter
    Name Description
    applicationName string

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

    {string} A string representing the tenant.

    matchTenantFromProfileName(profileName)

      matchTenantFromProfileName 
 ( 
 profileName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from Profile resource.

    Parameter
    Name Description
    profileName string

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

    {string} A string representing the tenant.

    matchTenantFromProjectTenantCompanyName(projectTenantCompanyName)

      matchTenantFromProjectTenantCompanyName 
 ( 
 projectTenantCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from ProjectTenantCompany resource.

    Parameter
    Name Description
    projectTenantCompanyName string

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

    {string} A string representing the tenant.

    matchTenantFromProjectTenantJobName(projectTenantJobName)

      matchTenantFromProjectTenantJobName 
 ( 
 projectTenantJobName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the tenant from ProjectTenantJob resource.

    Parameter
    Name Description
    projectTenantJobName string

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

    profilePath(project, tenant, profile)

      profilePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 tenant 
 : 
  
 string 
 , 
  
 profile 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified profile resource name string.

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

    {string} Resource name string.

    projectCompanyPath(project, company)

      projectCompanyPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 company 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectCompany resource name string.

    Parameters
    Name Description
    project string
    company string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectJobPath(project, job)

      projectJobPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 job 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectJob resource name string.

    Parameters
    Name Description
    project string
    job string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectPath(project)

      projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified project resource name string.

    Parameter
    Name Description
    project string
    Returns
    Type Description
    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.

    Parameters
    Name Description
    project string
    tenant string
    company string
    Returns
    Type Description
    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.

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

    {string} Resource name string.

    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: