Class AssistantServiceClient (0.66.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing Assistant configuration and assisting users.

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 (AssistantServiceClient assistantServiceClient = AssistantServiceClient.create()) {
   StreamAssistRequest request =
       StreamAssistRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .setQuery(Query.newBuilder().build())
           .setSession(
               SessionName.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .setUserMetadata(AssistUserMetadata.newBuilder().build())
           .setToolsSpec(StreamAssistRequest.ToolsSpec.newBuilder().build())
           .setGenerationSpec(StreamAssistRequest.GenerationSpec.newBuilder().build())
           .build();
   ServerStream<StreamAssistResponse> stream =
       assistantServiceClient.streamAssistCallable().call(request);
   for (StreamAssistResponse response : stream) {
     // Do something when a response is received.
   }
 }
 

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

StreamAssist

Assists the user with a query in a streaming fashion.

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

  • streamAssistCallable()

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 AssistantServiceSettings 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
 AssistantServiceSettings assistantServiceSettings =
     AssistantServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssistantServiceClient assistantServiceClient =
     AssistantServiceClient.create(assistantServiceSettings);
 

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
 AssistantServiceSettings assistantServiceSettings =
     AssistantServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssistantServiceClient assistantServiceClient =
     AssistantServiceClient.create(assistantServiceSettings);
 

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
 AssistantServiceSettings assistantServiceSettings =
     AssistantServiceSettings.newHttpJsonBuilder().build();
 AssistantServiceClient assistantServiceClient =
     AssistantServiceClient.create(assistantServiceSettings);
 

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

Inheritance

java.lang.Object > AssistantServiceClient

Static Methods

create()

public static final AssistantServiceClient create()

Constructs an instance of AssistantServiceClient with default settings.

Returns
Type Description
AssistantServiceClient
Exceptions
Type Description
IOException

create(AssistantServiceSettings settings)

public static final AssistantServiceClient create(AssistantServiceSettings settings)

Constructs an instance of AssistantServiceClient, 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 AssistantServiceSettings
Returns
Type Description
AssistantServiceClient
Exceptions
Type Description
IOException

create(AssistantServiceStub stub)

public static final AssistantServiceClient create(AssistantServiceStub stub)

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

Parameter
Name Description
stub AssistantServiceStub
Returns
Type Description
AssistantServiceClient

Constructors

AssistantServiceClient(AssistantServiceSettings settings)

protected AssistantServiceClient(AssistantServiceSettings settings)

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

AssistantServiceClient(AssistantServiceStub stub)

protected AssistantServiceClient(AssistantServiceStub stub)
Parameter
Name Description
stub AssistantServiceStub

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 AssistantServiceSettings getSettings()
Returns
Type Description
AssistantServiceSettings

getStub()

public AssistantServiceStub getStub()
Returns
Type Description
AssistantServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamAssistCallable()

public final ServerStreamingCallable<StreamAssistRequest,StreamAssistResponse> streamAssistCallable()

Assists the user with a query in a streaming fashion.

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 (AssistantServiceClient assistantServiceClient = AssistantServiceClient.create()) {
   StreamAssistRequest request =
       StreamAssistRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .setQuery(Query.newBuilder().build())
           .setSession(
               SessionName.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .setUserMetadata(AssistUserMetadata.newBuilder().build())
           .setToolsSpec(StreamAssistRequest.ToolsSpec.newBuilder().build())
           .setGenerationSpec(StreamAssistRequest.GenerationSpec.newBuilder().build())
           .build();
   ServerStream<StreamAssistResponse> stream =
       assistantServiceClient.streamAssistCallable().call(request);
   for (StreamAssistResponse response : stream) {
     // Do something when a response is received.
   }
 }
 
Returns
Type Description
ServerStreamingCallable<StreamAssistRequest,StreamAssistResponse>