Class AssistantServiceClient (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product 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()) {
   CreateAssistantRequest request =
       CreateAssistantRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setAssistant(Assistant.newBuilder().build())
           .setAssistantId("assistantId-324518759")
           .build();
   Assistant response = assistantServiceClient.createAssistant(request);
 }
 

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()
CreateAssistant	Creates an Assistant.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAssistant(CreateAssistantRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAssistantCallable()
DeleteAssistant	Deletes an Assistant.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAssistant(DeleteAssistantRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteAssistant(AssistantName name) deleteAssistant(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteAssistantCallable()
UpdateAssistant	Updates an Assistant	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAssistant(UpdateAssistantRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAssistant(Assistant assistant, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAssistantCallable()
GetAssistant	Gets an Assistant.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAssistant(GetAssistantRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAssistant(AssistantName name) getAssistant(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAssistantCallable()
ListAssistants	Lists all Assistants under an Engine.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAssistants(ListAssistantsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAssistants(EngineName parent) listAssistants(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAssistantsPagedCallable() listAssistantsCallable()

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()

createAssistant(CreateAssistantRequest request)

public final Assistant createAssistant(CreateAssistantRequest request)

Creates an Assistant.

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()) {
   CreateAssistantRequest request =
       CreateAssistantRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setAssistant(Assistant.newBuilder().build())
           .setAssistantId("assistantId-324518759")
           .build();
   Assistant response = assistantServiceClient.createAssistant(request);
 }
 

Parameter
Name	Description
request	CreateAssistantRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Assistant

createAssistantCallable()

public final UnaryCallable<CreateAssistantRequest,Assistant> createAssistantCallable()

Creates an Assistant.

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()) {
   CreateAssistantRequest request =
       CreateAssistantRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setAssistant(Assistant.newBuilder().build())
           .setAssistantId("assistantId-324518759")
           .build();
   ApiFuture<Assistant> future =
       assistantServiceClient.createAssistantCallable().futureCall(request);
   // Do something.
   Assistant response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateAssistantRequest,Assistant>

deleteAssistant(AssistantName name)

public final void deleteAssistant(AssistantName name)

Deletes an Assistant.

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()) {
   AssistantName name =
       AssistantName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]");
   assistantServiceClient.deleteAssistant(name);
 }
 

Parameter
Name	Description
name	AssistantName Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.

deleteAssistant(DeleteAssistantRequest request)

public final void deleteAssistant(DeleteAssistantRequest request)

Deletes an Assistant.

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()) {
   DeleteAssistantRequest request =
       DeleteAssistantRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .build();
   assistantServiceClient.deleteAssistant(request);
 }
 

Parameter
Name	Description
request	DeleteAssistantRequest The request object containing all of the parameters for the API call.

deleteAssistant(String name)

public final void deleteAssistant(String name)

Deletes an Assistant.

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()) {
   String name =
       AssistantName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
           .toString();
   assistantServiceClient.deleteAssistant(name);
 }
 

Parameter
Name	Description
name	String Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.

deleteAssistantCallable()

public final UnaryCallable<DeleteAssistantRequest,Empty> deleteAssistantCallable()

Deletes an Assistant.

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()) {
   DeleteAssistantRequest request =
       DeleteAssistantRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       assistantServiceClient.deleteAssistantCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteAssistantRequest,Empty>

getAssistant(AssistantName name)

public final Assistant getAssistant(AssistantName name)

Gets an Assistant.

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()) {
   AssistantName name =
       AssistantName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]");
   Assistant response = assistantServiceClient.getAssistant(name);
 }
 

Parameter
Name	Description
name	AssistantName Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Returns
Type	Description
Assistant

getAssistant(GetAssistantRequest request)

public final Assistant getAssistant(GetAssistantRequest request)

Gets an Assistant.

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()) {
   GetAssistantRequest request =
       GetAssistantRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .build();
   Assistant response = assistantServiceClient.getAssistant(request);
 }
 

Parameter
Name	Description
request	GetAssistantRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Assistant

getAssistant(String name)

public final Assistant getAssistant(String name)

Gets an Assistant.

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()) {
   String name =
       AssistantName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
           .toString();
   Assistant response = assistantServiceClient.getAssistant(name);
 }
 

Parameter
Name	Description
name	String Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Returns
Type	Description
Assistant

getAssistantCallable()

public final UnaryCallable<GetAssistantRequest,Assistant> getAssistantCallable()

Gets an Assistant.

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()) {
   GetAssistantRequest request =
       GetAssistantRequest.newBuilder()
           .setName(
               AssistantName.of(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
                   .toString())
           .build();
   ApiFuture<Assistant> future =
       assistantServiceClient.getAssistantCallable().futureCall(request);
   // Do something.
   Assistant response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetAssistantRequest,Assistant>

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

listAssistants(EngineName parent)

public final AssistantServiceClient.ListAssistantsPagedResponse listAssistants(EngineName parent)

Lists all Assistants under an Engine.

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()) {
   EngineName parent = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
   for (Assistant element : assistantServiceClient.listAssistants(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	EngineName Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
AssistantServiceClient.ListAssistantsPagedResponse

listAssistants(ListAssistantsRequest request)

public final AssistantServiceClient.ListAssistantsPagedResponse listAssistants(ListAssistantsRequest request)

Lists all Assistants under an Engine.

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()) {
   ListAssistantsRequest request =
       ListAssistantsRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Assistant element : assistantServiceClient.listAssistants(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListAssistantsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
AssistantServiceClient.ListAssistantsPagedResponse

listAssistants(String parent)

public final AssistantServiceClient.ListAssistantsPagedResponse listAssistants(String parent)

Lists all Assistants under an Engine.

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()) {
   String parent =
       EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
   for (Assistant element : assistantServiceClient.listAssistants(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
AssistantServiceClient.ListAssistantsPagedResponse

listAssistantsCallable()

public final UnaryCallable<ListAssistantsRequest,ListAssistantsResponse> listAssistantsCallable()

Lists all Assistants under an Engine.

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()) {
   ListAssistantsRequest request =
       ListAssistantsRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAssistantsResponse response =
         assistantServiceClient.listAssistantsCallable().call(request);
     for (Assistant element : response.getAssistantsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListAssistantsRequest,ListAssistantsResponse>

listAssistantsPagedCallable()

public final UnaryCallable<ListAssistantsRequest,AssistantServiceClient.ListAssistantsPagedResponse> listAssistantsPagedCallable()

Lists all Assistants under an Engine.

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()) {
   ListAssistantsRequest request =
       ListAssistantsRequest.newBuilder()
           .setParent(
               EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Assistant> future =
       assistantServiceClient.listAssistantsPagedCallable().futureCall(request);
   // Do something.
   for (Assistant element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListAssistantsRequest,ListAssistantsPagedResponse>

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>

updateAssistant(Assistant assistant, FieldMask updateMask)

public final Assistant updateAssistant(Assistant assistant, FieldMask updateMask)

Updates an Assistant

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()) {
   Assistant assistant = Assistant.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Assistant response = assistantServiceClient.updateAssistant(assistant, updateMask);
 }
 

Parameters
Name	Description
assistant	Assistant Required. The Assistant to update. The Assistant's name field is used to identify the Assistant to update. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to update the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to update does not exist, a NOT_FOUND error is returned.
updateMask	FieldMask The list of fields to update.

Returns
Type	Description
Assistant

updateAssistant(UpdateAssistantRequest request)

public final Assistant updateAssistant(UpdateAssistantRequest request)

Updates an Assistant

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()) {
   UpdateAssistantRequest request =
       UpdateAssistantRequest.newBuilder()
           .setAssistant(Assistant.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Assistant response = assistantServiceClient.updateAssistant(request);
 }
 

Parameter
Name	Description
request	UpdateAssistantRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Assistant

updateAssistantCallable()

public final UnaryCallable<UpdateAssistantRequest,Assistant> updateAssistantCallable()

Updates an Assistant

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()) {
   UpdateAssistantRequest request =
       UpdateAssistantRequest.newBuilder()
           .setAssistant(Assistant.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Assistant> future =
       assistantServiceClient.updateAssistantCallable().futureCall(request);
   // Do something.
   Assistant response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateAssistantRequest,Assistant>