Class EventServiceClient (3.0.0-beta01)

Stay organized with collections Save and categorize content based on your preferences.
public abstract class EventServiceClient

EventService client wrapper, for convenient use.

Inheritance

Object > EventServiceClient

Derived Types

Namespace

Google.Cloud.Talent.V4Beta1

Assembly

Google.Cloud.Talent.V4Beta1.dll

Remarks

A service handles client event report.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the EventService service, which is a host of "jobs.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default EventService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

GrpcClient

public virtual EventService.EventServiceClient GrpcClient { get; }

The underlying gRPC EventService client

Property Value
TypeDescription
EventService.EventServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static EventServiceClient Create()

Synchronously creates a EventServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EventServiceClientBuilder.

Returns
TypeDescription
EventServiceClient

The created EventServiceClient.

CreateAsync(CancellationToken)

public static Task<EventServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a EventServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EventServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<EventServiceClient>

The task representing the created EventServiceClient.

CreateClientEvent(ProjectName, ClientEvent, CallSettings)

public virtual ClientEvent CreateClientEvent(ProjectName parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentProjectName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ClientEvent

The RPC response.

Example
// Create client
EventServiceClient eventServiceClient = EventServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = eventServiceClient.CreateClientEvent(parent, clientEvent);

CreateClientEvent(CreateClientEventRequest, CallSettings)

public virtual ClientEvent CreateClientEvent(CreateClientEventRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateClientEventRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ClientEvent

The RPC response.

Example
// Create client
EventServiceClient eventServiceClient = EventServiceClient.Create();
// Initialize request argument(s)
CreateClientEventRequest request = new CreateClientEventRequest
{
    ParentAsTenantName = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]"),
    ClientEvent = new ClientEvent(),
};
// Make the request
ClientEvent response = eventServiceClient.CreateClientEvent(request);

CreateClientEvent(TenantName, ClientEvent, CallSettings)

public virtual ClientEvent CreateClientEvent(TenantName parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentTenantName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ClientEvent

The RPC response.

Example
// Create client
EventServiceClient eventServiceClient = EventServiceClient.Create();
// Initialize request argument(s)
TenantName parent = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = eventServiceClient.CreateClientEvent(parent, clientEvent);

CreateClientEvent(String, ClientEvent, CallSettings)

public virtual ClientEvent CreateClientEvent(string parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentString

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ClientEvent

The RPC response.

Example
// Create client
EventServiceClient eventServiceClient = EventServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/tenants/[TENANT]";
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = eventServiceClient.CreateClientEvent(parent, clientEvent);

CreateClientEventAsync(ProjectName, ClientEvent, CallSettings)

public virtual Task<ClientEvent> CreateClientEventAsync(ProjectName parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentProjectName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

CreateClientEventAsync(ProjectName, ClientEvent, CancellationToken)

public virtual Task<ClientEvent> CreateClientEventAsync(ProjectName parent, ClientEvent clientEvent, CancellationToken cancellationToken)

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
NameDescription
parentProjectName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

CreateClientEventAsync(CreateClientEventRequest, CallSettings)

public virtual Task<ClientEvent> CreateClientEventAsync(CreateClientEventRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateClientEventRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
CreateClientEventRequest request = new CreateClientEventRequest
{
    ParentAsTenantName = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]"),
    ClientEvent = new ClientEvent(),
};
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(request);

CreateClientEventAsync(CreateClientEventRequest, CancellationToken)

public virtual Task<ClientEvent> CreateClientEventAsync(CreateClientEventRequest request, CancellationToken cancellationToken)

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
NameDescription
requestCreateClientEventRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
CreateClientEventRequest request = new CreateClientEventRequest
{
    ParentAsTenantName = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]"),
    ClientEvent = new ClientEvent(),
};
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(request);

CreateClientEventAsync(TenantName, ClientEvent, CallSettings)

public virtual Task<ClientEvent> CreateClientEventAsync(TenantName parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentTenantName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
TenantName parent = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

CreateClientEventAsync(TenantName, ClientEvent, CancellationToken)

public virtual Task<ClientEvent> CreateClientEventAsync(TenantName parent, ClientEvent clientEvent, CancellationToken cancellationToken)

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
NameDescription
parentTenantName

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
TenantName parent = TenantName.FromProjectTenant("[PROJECT]", "[TENANT]");
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

CreateClientEventAsync(String, ClientEvent, CallSettings)

public virtual Task<ClientEvent> CreateClientEventAsync(string parent, ClientEvent clientEvent, CallSettings callSettings = null)

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
NameDescription
parentString

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/tenants/[TENANT]";
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

CreateClientEventAsync(String, ClientEvent, CancellationToken)

public virtual Task<ClientEvent> CreateClientEventAsync(string parent, ClientEvent clientEvent, CancellationToken cancellationToken)

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
NameDescription
parentString

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".

clientEventClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ClientEvent>

A Task containing the RPC response.

Example
// Create client
EventServiceClient eventServiceClient = await EventServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/tenants/[TENANT]";
ClientEvent clientEvent = new ClientEvent();
// Make the request
ClientEvent response = await eventServiceClient.CreateClientEventAsync(parent, clientEvent);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.