Class EventServiceClient (0.3.0)

EventServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

A service handles client event report.

Methods

EventServiceClient

EventServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
NameDescription
channel grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

credentials google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

client_config dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

create_client_event

create_client_event(parent, client_event, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.EventServiceClient()

parent = client.tenant_path('[PROJECT]', '[TENANT]')

TODO: Initialize client_event:

client_event = {}

response = client.create_client_event(parent, client_event)

Parameters
NameDescription
parent str

Required. Resource name of the tenant under which the event is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project".

client_event Union[dict, ClientEvent]

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution. If a dict is provided, it must be of the same form as the protobuf message ClientEvent

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will not be retried.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
EventServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
EventServiceClientThe constructed client.

project_path

project_path(project)

Return a fully-qualified project string.

tenant_path

tenant_path(project, tenant)

Return a fully-qualified tenant string.