Class RecommendationServiceClient (0.51.0)

GitHub RepositoryProduct Reference

Service Description: Service for making recommendations.

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 (RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create()) {
   RecommendRequest request =
       RecommendRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setPageSize(883849137)
           .setFilter("filter-1274492040")
           .setValidateOnly(true)
           .putAllParams(new HashMap<String, Value>())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RecommendResponse response = recommendationServiceClient.recommend(request);
 }

Note: close() needs to be called on the RecommendationServiceClient 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

Recommend

Makes a recommendation, which requires a contextual user event.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • recommend(RecommendRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • recommendCallable()

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 RecommendationServiceSettings 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
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

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
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

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
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newHttpJsonBuilder().build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

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

Inheritance

java.lang.Object > RecommendationServiceClient

Static Methods

create()

public static final RecommendationServiceClient create()

Constructs an instance of RecommendationServiceClient with default settings.

Returns
Type Description
RecommendationServiceClient
Exceptions
Type Description
IOException

create(RecommendationServiceSettings settings)

public static final RecommendationServiceClient create(RecommendationServiceSettings settings)

Constructs an instance of RecommendationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings RecommendationServiceSettings
Returns
Type Description
RecommendationServiceClient
Exceptions
Type Description
IOException

create(RecommendationServiceStub stub)

public static final RecommendationServiceClient create(RecommendationServiceStub stub)

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

Parameter
Name Description
stub RecommendationServiceStub
Returns
Type Description
RecommendationServiceClient

Constructors

RecommendationServiceClient(RecommendationServiceSettings settings)

protected RecommendationServiceClient(RecommendationServiceSettings settings)

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

Parameter
Name Description
settings RecommendationServiceSettings

RecommendationServiceClient(RecommendationServiceStub stub)

protected RecommendationServiceClient(RecommendationServiceStub stub)
Parameter
Name Description
stub RecommendationServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getSettings()

public final RecommendationServiceSettings getSettings()
Returns
Type Description
RecommendationServiceSettings

getStub()

public RecommendationServiceStub getStub()
Returns
Type Description
RecommendationServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

recommend(RecommendRequest request)

public final RecommendResponse recommend(RecommendRequest request)

Makes a recommendation, which requires a contextual 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 (RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create()) {
   RecommendRequest request =
       RecommendRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setPageSize(883849137)
           .setFilter("filter-1274492040")
           .setValidateOnly(true)
           .putAllParams(new HashMap<String, Value>())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RecommendResponse response = recommendationServiceClient.recommend(request);
 }
Parameter
Name Description
request RecommendRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RecommendResponse

recommendCallable()

public final UnaryCallable<RecommendRequest,RecommendResponse> recommendCallable()

Makes a recommendation, which requires a contextual 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 (RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create()) {
   RecommendRequest request =
       RecommendRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setPageSize(883849137)
           .setFilter("filter-1274492040")
           .setValidateOnly(true)
           .putAllParams(new HashMap<String, Value>())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   ApiFuture<RecommendResponse> future =
       recommendationServiceClient.recommendCallable().futureCall(request);
   // Do something.
   RecommendResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<RecommendRequest,RecommendResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()