EventServiceClient

EventServiceClient

A service handles client event report.

Constructor

new EventServiceClient(optionsopt)

Construct an instance of EventServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

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

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

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

A promise that resolves when the client is closed.

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

Return a fully-qualified company resource name string.

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

Resource name string.

createClientEvent(request, optionsopt) → {Promise}

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. Learn more about self service tools.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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".
clientEvent google.cloud.talent.v4.ClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing ClientEvent. Please see the documentation for more details and examples.
Example
const [response] = await client.createClientEvent(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

jobPath(project, tenant, job) → {string}

Return a fully-qualified job resource name string.

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

Resource name string.

matchCompanyFromCompanyName(companyName) → {string}

Parse the company from Company resource.

Parameters:
Name Type Description
companyName string

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

A string representing the company.

matchJobFromJobName(jobName) → {string}

Parse the job from Job resource.

Parameters:
Name Type Description
jobName string

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

A string representing the job.

matchProjectFromCompanyName(companyName) → {string}

Parse the project from Company resource.

Parameters:
Name Type Description
companyName string

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

A string representing the project.

matchProjectFromJobName(jobName) → {string}

Parse the project from Job resource.

Parameters:
Name Type Description
jobName string

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

A string representing the project.

matchProjectFromTenantName(tenantName) → {string}

Parse the project from Tenant resource.

Parameters:
Name Type Description
tenantName string

A fully-qualified path representing Tenant resource.
Returns:
Type Description
string

A string representing the project.

matchTenantFromCompanyName(companyName) → {string}

Parse the tenant from Company resource.

Parameters:
Name Type Description
companyName string

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

A string representing the tenant.

matchTenantFromJobName(jobName) → {string}

Parse the tenant from Job resource.

Parameters:
Name Type Description
jobName string

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

A string representing the tenant.

matchTenantFromTenantName(tenantName) → {string}

Parse the tenant from Tenant resource.

Parameters:
Name Type Description
tenantName string

A fully-qualified path representing Tenant resource.
Returns:
Type Description
string

A string representing the tenant.

tenantPath(project, tenant) → {string}

Return a fully-qualified tenant resource name string.

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

Resource name string.