EventServiceClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class EventServiceClient
extends Object
implements com.google.api.gax.core.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:
```
 
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   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:
```
 
 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EventServiceClient eventServiceClient =
     EventServiceClient.create(eventServiceSettings);
 
 
```
To customize the endpoint:
```
 
 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EventServiceClient eventServiceClient =
     EventServiceClient.create(eventServiceSettings);
 
 
```

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(String parent, ClientEvent clientEvent)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`ClientEvent`	`createClientEvent(TenantOrProjectName parent, ClientEvent clientEvent)` Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
`com.google.api.gax.rpc.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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use EventServiceSettings}.
  - getSettings
```
public final EventServiceSettings getSettings()
```
  - getStub
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public EventServiceStub getStub()
```
  - createClientEvent
```
public final ClientEvent createClientEvent(TenantOrProjectName 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:
```
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantOrProjectName 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:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - createClientEvent
```
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](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:
```
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent.toString(), 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:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - createClientEvent
```
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](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:
```
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   CreateClientEventRequest request = CreateClientEventRequest.newBuilder()
     .setParent(parent.toString())
     .setClientEvent(clientEvent)
     .build();
   ClientEvent response = eventServiceClient.createClientEvent(request);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - createClientEventCallable
```
public final com.google.api.gax.rpc.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](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:
```
 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   CreateClientEventRequest request = CreateClientEventRequest.newBuilder()
     .setParent(parent.toString())
     .setClientEvent(clientEvent)
     .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 com.google.api.gax.core.BackgroundResource
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface com.google.api.gax.core.BackgroundResource
  - isTerminated
```
public boolean isTerminated()
```
    Specified by:
    
    isTerminated in interface com.google.api.gax.core.BackgroundResource
  - shutdownNow
```
public void shutdownNow()
```
    Specified by:
    
    shutdownNow in interface com.google.api.gax.core.BackgroundResource
  - awaitTermination
```
public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException
```
    Specified by:
    
    awaitTermination in interface com.google.api.gax.core.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

createClientEventCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination