com.google.cloud.discoveryengine.v1.UserEventServiceClient Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.discoveryengine.v1;
import com.google.api.HttpBody;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.discoveryengine.v1.stub.UserEventServiceStub;
import com.google.cloud.discoveryengine.v1.stub.UserEventServiceStubSettings;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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())
* .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()
*
*
*
*
* 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:
*
*
{@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
* UserEventServiceSettings userEventServiceSettings =
* UserEventServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* UserEventServiceClient userEventServiceClient =
* UserEventServiceClient.create(userEventServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* UserEventServiceSettings userEventServiceSettings =
* UserEventServiceSettings.newHttpJsonBuilder().build();
* UserEventServiceClient userEventServiceClient =
* UserEventServiceClient.create(userEventServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class UserEventServiceClient implements BackgroundResource {
private final UserEventServiceSettings settings;
private final UserEventServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of UserEventServiceClient with default settings. */
public static final UserEventServiceClient create() throws IOException {
return create(UserEventServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final UserEventServiceClient create(UserEventServiceSettings settings)
throws IOException {
return new UserEventServiceClient(settings);
}
/**
* Constructs an instance of UserEventServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(UserEventServiceSettings).
*/
public static final UserEventServiceClient create(UserEventServiceStub stub) {
return new UserEventServiceClient(stub);
}
/**
* 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.
*/
protected UserEventServiceClient(UserEventServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((UserEventServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected UserEventServiceClient(UserEventServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final UserEventServiceSettings getSettings() {
return settings;
}
public UserEventServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
*
Sample code:
*
*
{@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())
* .build();
* UserEvent response = userEventServiceClient.writeUserEvent(request);
* }
* }
*
* @param 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
*/
public final UserEvent writeUserEvent(WriteUserEventRequest request) {
return writeUserEventCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event.
*
* Sample code:
*
*
{@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())
* .build();
* ApiFuture future =
* userEventServiceClient.writeUserEventCallable().futureCall(request);
* // Do something.
* UserEvent response = future.get();
* }
* }
*/
public final UnaryCallable writeUserEventCallable() {
return stub.writeUserEventCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final HttpBody collectUserEvent(CollectUserEventRequest request) {
return collectUserEventCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 future =
* userEventServiceClient.collectUserEventCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable collectUserEventCallable() {
return stub.collectUserEventCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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();
* }
* }
*
* @param 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
*/
public final OperationFuture
importUserEventsAsync(ImportUserEventsRequest request) {
return importUserEventsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 future =
* userEventServiceClient.importUserEventsOperationCallable().futureCall(request);
* // Do something.
* ImportUserEventsResponse response = future.get();
* }
* }
*/
public final OperationCallable<
ImportUserEventsRequest, ImportUserEventsResponse, ImportUserEventsMetadata>
importUserEventsOperationCallable() {
return stub.importUserEventsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 future =
* userEventServiceClient.importUserEventsCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable importUserEventsCallable() {
return stub.importUserEventsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}