@Generated(value="by gapic-generator") @BetaApi public class EventServiceClient extends Object implements BackgroundResource
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:
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);
Modifier | Constructor and Description |
---|---|
protected |
EventServiceClient(EventServiceSettings settings)
Constructs an instance of EventServiceClient, using the given settings.
|
protected |
EventServiceClient(EventServiceStub stub) |
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.
|
com.google.cloud.talent.v4beta1.ClientEvent |
createClientEvent(com.google.cloud.talent.v4beta1.CreateClientEventRequest request)
Report events issued when end user interacts with customer's application that uses Cloud Talent
Solution.
|
com.google.cloud.talent.v4beta1.ClientEvent |
createClientEvent(String parent,
com.google.cloud.talent.v4beta1.ClientEvent clientEvent)
Report events issued when end user interacts with customer's application that uses Cloud Talent
Solution.
|
com.google.cloud.talent.v4beta1.ClientEvent |
createClientEvent(com.google.cloud.talent.v4beta1.TenantOrProjectName parent,
com.google.cloud.talent.v4beta1.ClientEvent clientEvent)
Report events issued when end user interacts with customer's application that uses Cloud Talent
Solution.
|
UnaryCallable<com.google.cloud.talent.v4beta1.CreateClientEventRequest,com.google.cloud.talent.v4beta1.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() |
protected EventServiceClient(EventServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected EventServiceClient(EventServiceStub stub)
public static final EventServiceClient create() throws IOException
IOException
public static final EventServiceClient create(EventServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final EventServiceClient create(EventServiceStub stub)
public final EventServiceSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public EventServiceStub getStub()
public final com.google.cloud.talent.v4beta1.ClientEvent createClientEvent(com.google.cloud.talent.v4beta1.TenantOrProjectName parent, com.google.cloud.talent.v4beta1.ClientEvent clientEvent)
Sample code:
try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
ClientEvent clientEvent = ClientEvent.newBuilder().build();
ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
}
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/api-test-project/tenant/foo".
Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project".
clientEvent
- Required.
Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
ApiException
- if the remote call failspublic final com.google.cloud.talent.v4beta1.ClientEvent createClientEvent(String parent, com.google.cloud.talent.v4beta1.ClientEvent clientEvent)
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);
}
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/api-test-project/tenant/foo".
Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project".
clientEvent
- Required.
Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
ApiException
- if the remote call failspublic final com.google.cloud.talent.v4beta1.ClientEvent createClientEvent(com.google.cloud.talent.v4beta1.CreateClientEventRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.talent.v4beta1.CreateClientEventRequest,com.google.cloud.talent.v4beta1.ClientEvent> createClientEventCallable()
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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.