Class EventServiceClient (2.22.0)

Version 2.22.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

public class EventServiceClient implements BackgroundResource

Service Description: A service handles client event report.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

Note: close() needs to be called on the EventServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EventServiceSettings to create(). For example:

To customize credentials:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);
 

To customize the endpoint:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EventServiceSettings eventServiceSettings = EventServiceSettings.newHttpJsonBuilder().build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > EventServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final EventServiceClient create()

Constructs an instance of EventServiceClient with default settings.

Returns
Type	Description
EventServiceClient

Exceptions
Type	Description
IOException

create(EventServiceSettings settings)

public static final EventServiceClient create(EventServiceSettings settings)

Constructs an instance of EventServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	EventServiceSettings

Returns
Type	Description
EventServiceClient

Exceptions
Type	Description
IOException

create(EventServiceStub stub)

public static final EventServiceClient create(EventServiceStub stub)

Constructs an instance of EventServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(EventServiceSettings).

Parameter
Name	Description
stub	EventServiceStub

Returns
Type	Description
EventServiceClient

Constructors

EventServiceClient(EventServiceSettings settings)

protected EventServiceClient(EventServiceSettings settings)

Constructs an instance of EventServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
settings	EventServiceSettings

EventServiceClient(EventServiceStub stub)

protected EventServiceClient(EventServiceStub stub)

Parameter
Name	Description
stub	EventServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

createClientEvent(CreateClientEventRequest request)

public final ClientEvent createClientEvent(CreateClientEventRequest request)

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.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   CreateClientEventRequest request =
       CreateClientEventRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setClientEvent(ClientEvent.newBuilder().build())
           .build();
   ClientEvent response = eventServiceClient.createClientEvent(request);
 }
 

Parameter
Name	Description
request	CreateClientEventRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ClientEvent

createClientEvent(ProjectName parent, ClientEvent clientEvent)

public final ClientEvent createClientEvent(ProjectName parent, ClientEvent clientEvent)

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.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

Parameters
Name	Description
parent	ProjectName 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".
clientEvent	ClientEvent Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

Returns
Type	Description
ClientEvent

createClientEvent(TenantName parent, ClientEvent clientEvent)

public final ClientEvent createClientEvent(TenantName parent, ClientEvent clientEvent)

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.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

Parameters
Name	Description
parent	TenantName 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".
clientEvent	ClientEvent Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

Returns
Type	Description
ClientEvent

createClientEvent(String parent, ClientEvent clientEvent)

public final ClientEvent createClientEvent(String parent, ClientEvent clientEvent)

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.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   String parent = TenantName.of("[PROJECT]", "[TENANT]").toString();
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

Parameters
Name	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/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".
clientEvent	ClientEvent Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

Returns
Type	Description
ClientEvent

createClientEventCallable()

public final UnaryCallable<CreateClientEventRequest,ClientEvent> createClientEventCallable()

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.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   CreateClientEventRequest request =
       CreateClientEventRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setClientEvent(ClientEvent.newBuilder().build())
           .build();
   ApiFuture<ClientEvent> future =
       eventServiceClient.createClientEventCallable().futureCall(request);
   // Do something.
   ClientEvent response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateClientEventRequest,ClientEvent>

getSettings()

public final EventServiceSettings getSettings()

Returns
Type	Description
EventServiceSettings

getStub()

public EventServiceStub getStub()

Returns
Type	Description
EventServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()