com.google.cloud.discoveryengine.v1

Class UserEventServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.UserEventServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class UserEventServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for ingesting end user actions on a website to Discovery Engine API.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   WriteUserEventRequest request =
       WriteUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setWriteAsync(true)
           .build();
   UserEvent response = userEventServiceClient.writeUserEvent(request);
 }
 

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

Methods

Method	Description	Method Variants
WriteUserEvent	Writes a single user event.	Request object method variants only take one parameter, a request object, which must be constructed before the call. writeUserEvent(WriteUserEventRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. writeUserEventCallable()
CollectUserEvent	Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.	Request object method variants only take one parameter, a request object, which must be constructed before the call. collectUserEvent(CollectUserEventRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. collectUserEventCallable()
PurgeUserEvents	Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.	Request object method variants only take one parameter, a request object, which must be constructed before the call. purgeUserEventsAsync(PurgeUserEventsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. purgeUserEventsOperationCallable() purgeUserEventsCallable()
ImportUserEvents	Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importUserEventsAsync(ImportUserEventsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importUserEventsOperationCallable() importUserEventsCallable()

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 UserEventServiceSettings 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
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);
 

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
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);
 

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
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newHttpJsonBuilder().build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserEventServiceClient(UserEventServiceSettings settings) Constructs an instance of UserEventServiceClient, using the given settings.
protected	UserEventServiceClient(UserEventServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
com.google.api.HttpBody	collectUserEvent(CollectUserEventRequest request) Writes a single user event from the browser.
com.google.api.gax.rpc.UnaryCallable<CollectUserEventRequest,com.google.api.HttpBody>	collectUserEventCallable() Writes a single user event from the browser.
static UserEventServiceClient	create() Constructs an instance of UserEventServiceClient with default settings.
static UserEventServiceClient	create(UserEventServiceSettings settings) Constructs an instance of UserEventServiceClient, using the given settings.
static UserEventServiceClient	create(UserEventServiceStub stub) Constructs an instance of UserEventServiceClient, using the given stub for making calls.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
UserEventServiceSettings	getSettings()
UserEventServiceStub	getStub()
com.google.api.gax.longrunning.OperationFuture<ImportUserEventsResponse,ImportUserEventsMetadata>	importUserEventsAsync(ImportUserEventsRequest request) Bulk import of user events.
com.google.api.gax.rpc.UnaryCallable<ImportUserEventsRequest,com.google.longrunning.Operation>	importUserEventsCallable() Bulk import of user events.
com.google.api.gax.rpc.OperationCallable<ImportUserEventsRequest,ImportUserEventsResponse,ImportUserEventsMetadata>	importUserEventsOperationCallable() Bulk import of user events.
boolean	isShutdown()
boolean	isTerminated()
com.google.api.gax.longrunning.OperationFuture<PurgeUserEventsResponse,PurgeUserEventsMetadata>	purgeUserEventsAsync(PurgeUserEventsRequest request) Deletes permanently all user events specified by the filter provided.
com.google.api.gax.rpc.UnaryCallable<PurgeUserEventsRequest,com.google.longrunning.Operation>	purgeUserEventsCallable() Deletes permanently all user events specified by the filter provided.
com.google.api.gax.rpc.OperationCallable<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeUserEventsMetadata>	purgeUserEventsOperationCallable() Deletes permanently all user events specified by the filter provided.
void	shutdown()
void	shutdownNow()
UserEvent	writeUserEvent(WriteUserEventRequest request) Writes a single user event.
com.google.api.gax.rpc.UnaryCallable<WriteUserEventRequest,UserEvent>	writeUserEventCallable() Writes a single user event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserEventServiceClient

protected UserEventServiceClient(UserEventServiceSettings settings)
                          throws IOException

Constructs an instance of UserEventServiceClient, 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

UserEventServiceClient

protected UserEventServiceClient(UserEventServiceStub stub)

Method Detail

create

public static final UserEventServiceClient create()
                                           throws IOException

Constructs an instance of UserEventServiceClient with default settings.

Throws:

IOException

create

public static final UserEventServiceClient create(UserEventServiceSettings settings)
                                           throws IOException

Constructs an instance of UserEventServiceClient, 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 UserEventServiceClient create(UserEventServiceStub stub)

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

getSettings

public final UserEventServiceSettings getSettings()

getStub

public UserEventServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

writeUserEvent

public final UserEvent writeUserEvent(WriteUserEventRequest request)

Writes a single user event.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   WriteUserEventRequest request =
       WriteUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setWriteAsync(true)
           .build();
   UserEvent response = userEventServiceClient.writeUserEvent(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

writeUserEventCallable

public final com.google.api.gax.rpc.UnaryCallable<WriteUserEventRequest,UserEvent> writeUserEventCallable()

Writes a single user event.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   WriteUserEventRequest request =
       WriteUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setWriteAsync(true)
           .build();
   ApiFuture<UserEvent> future =
       userEventServiceClient.writeUserEventCallable().futureCall(request);
   // Do something.
   UserEvent response = future.get();
 }
 

collectUserEvent

public final com.google.api.HttpBody collectUserEvent(CollectUserEventRequest request)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain.

This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   CollectUserEventRequest request =
       CollectUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent("userEvent315571599")
           .setUri("uri116076")
           .setEts(100772)
           .build();
   HttpBody response = userEventServiceClient.collectUserEvent(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

collectUserEventCallable

public final com.google.api.gax.rpc.UnaryCallable<CollectUserEventRequest,com.google.api.HttpBody> collectUserEventCallable()

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain.

This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   CollectUserEventRequest request =
       CollectUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent("userEvent315571599")
           .setUri("uri116076")
           .setEts(100772)
           .build();
   ApiFuture<HttpBody> future =
       userEventServiceClient.collectUserEventCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }
 

purgeUserEventsAsync

public final com.google.api.gax.longrunning.OperationFuture<PurgeUserEventsResponse,PurgeUserEventsMetadata> purgeUserEventsAsync(PurgeUserEventsRequest request)

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   PurgeUserEventsRequest request =
       PurgeUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setForce(true)
           .build();
   PurgeUserEventsResponse response = userEventServiceClient.purgeUserEventsAsync(request).get();
 }
 

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

purgeUserEventsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeUserEventsMetadata> purgeUserEventsOperationCallable()

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   PurgeUserEventsRequest request =
       PurgeUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setForce(true)
           .build();
   OperationFuture<PurgeUserEventsResponse, PurgeUserEventsMetadata> future =
       userEventServiceClient.purgeUserEventsOperationCallable().futureCall(request);
   // Do something.
   PurgeUserEventsResponse response = future.get();
 }
 

purgeUserEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<PurgeUserEventsRequest,com.google.longrunning.Operation> purgeUserEventsCallable()

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   PurgeUserEventsRequest request =
       PurgeUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       userEventServiceClient.purgeUserEventsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

importUserEventsAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportUserEventsResponse,ImportUserEventsMetadata> importUserEventsAsync(ImportUserEventsRequest request)

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   ImportUserEventsRequest request =
       ImportUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   ImportUserEventsResponse response =
       userEventServiceClient.importUserEventsAsync(request).get();
 }
 

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

importUserEventsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ImportUserEventsRequest,ImportUserEventsResponse,ImportUserEventsMetadata> importUserEventsOperationCallable()

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   ImportUserEventsRequest request =
       ImportUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   OperationFuture<ImportUserEventsResponse, ImportUserEventsMetadata> future =
       userEventServiceClient.importUserEventsOperationCallable().futureCall(request);
   // Do something.
   ImportUserEventsResponse response = future.get();
 }
 

importUserEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportUserEventsRequest,com.google.longrunning.Operation> importUserEventsCallable()

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.

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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   ImportUserEventsRequest request =
       ImportUserEventsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       userEventServiceClient.importUserEventsCallable().futureCall(request);
   // Do something.
   Operation 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