EventServiceClient (Google Cloud Talent Solution Parent 2.4.6 API)

java.lang.Object
- com.google.cloud.talent.v4beta1.EventServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EventServiceClient
extends Object
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:

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.
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.
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.newBuilder()
         .setTransportChannelProvider(
             EventServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EventServiceClient(EventServiceSettings settings)` Constructs an instance of EventServiceClient, using the given settings.
`protected`	`EventServiceClient(EventServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static EventServiceClient`	`create()` Constructs an instance of EventServiceClient with default settings.
`static EventServiceClient`	`create(EventServiceSettings settings)` Constructs an instance of EventServiceClient, using the given settings.
`static EventServiceClient`	`create(EventServiceStub stub)` Constructs an instance of EventServiceClient, using the given stub for making calls.
`ClientEvent`	`createClientEvent(CreateClientEventRequest request)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`ClientEvent`	`createClientEvent(ProjectName parent, ClientEvent clientEvent)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`ClientEvent`	`createClientEvent(String parent, ClientEvent clientEvent)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`ClientEvent`	`createClientEvent(TenantName parent, ClientEvent clientEvent)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`UnaryCallable<CreateClientEventRequest,ClientEvent>`	`createClientEventCallable()` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`EventServiceSettings`	`getSettings()`
`EventServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EventServiceClient
```
protected EventServiceClient(EventServiceSettings settings)
                      throws IOException
```
  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.
  
  Throws:
  
  IOException
- EventServiceClient
```
protected EventServiceClient(EventServiceStub stub)
```

Method Detail

create

public static final EventServiceClient create()
                                       throws IOException

Constructs an instance of EventServiceClient with default settings.

Throws:: IOException

create
```
public static final EventServiceClient create(EventServiceSettings settings)
                                       throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final EventServiceSettings getSettings()

getStub
```
public EventServiceStub getStub()
```

createClientEvent

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](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) 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:: parent - 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 - Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
Throws:: ApiException - if the remote call fails

createClientEvent

public final ClientEvent createClientEvent(TenantName parent,
                                           ClientEvent clientEvent)

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:: parent - 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 - Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
Throws:: ApiException - if the remote call fails

createClientEvent

public final ClientEvent createClientEvent(String parent,
                                           ClientEvent clientEvent)

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:: parent - 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 - Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
Throws:: ApiException - if the remote call fails

createClientEvent

public final ClientEvent createClientEvent(CreateClientEventRequest request)

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createClientEventCallable

public final UnaryCallable<CreateClientEventRequest,ClientEvent> createClientEventCallable()

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();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class EventServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventServiceClient

EventServiceClient

Method Detail

create

create

create

getSettings

getStub

createClientEvent

createClientEvent

createClientEvent

createClientEvent

createClientEventCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination