Class ConversationalSearchServiceClient (0.36.0)

GitHub RepositoryProduct Reference

Service Description: Service for conversational search.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationName name =
       ConversationName.ofProjectLocationDataStoreConversationName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
   TextInput query = TextInput.newBuilder().build();
   ConverseConversationResponse response =
       conversationalSearchServiceClient.converseConversation(name, query);
 }
 

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

Methods
MethodDescriptionMethod Variants

ConverseConversation

Converses a conversation.

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

  • converseConversation(ConverseConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • converseConversation(ConversationName name, TextInput query)

  • converseConversation(String name, TextInput query)

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

  • converseConversationCallable()

CreateConversation

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

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

  • createConversation(CreateConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createConversation(DataStoreName parent, Conversation conversation)

  • createConversation(String parent, Conversation conversation)

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

  • createConversationCallable()

DeleteConversation

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

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

  • deleteConversation(DeleteConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteConversation(ConversationName name)

  • deleteConversation(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.

  • deleteConversationCallable()

UpdateConversation

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

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

  • updateConversation(UpdateConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateConversation(Conversation conversation, 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.

  • updateConversationCallable()

GetConversation

Gets a Conversation.

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

  • getConversation(GetConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getConversation(ConversationName name)

  • getConversation(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.

  • getConversationCallable()

ListConversations

Lists all Conversations by their parent DataStore.

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

  • listConversations(ListConversationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listConversations(DataStoreName parent)

  • listConversations(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.

  • listConversationsPagedCallable()

  • listConversationsCallable()

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 ConversationalSearchServiceSettings 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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);
 

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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);
 

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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newHttpJsonBuilder().build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);
 

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

Inheritance

java.lang.Object > ConversationalSearchServiceClient

Static Methods

create()

public static final ConversationalSearchServiceClient create()

Constructs an instance of ConversationalSearchServiceClient with default settings.

Returns
TypeDescription
ConversationalSearchServiceClient
Exceptions
TypeDescription
IOException

create(ConversationalSearchServiceSettings settings)

public static final ConversationalSearchServiceClient create(ConversationalSearchServiceSettings settings)

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

Parameter
NameDescription
settingsConversationalSearchServiceSettings
Returns
TypeDescription
ConversationalSearchServiceClient
Exceptions
TypeDescription
IOException

create(ConversationalSearchServiceStub stub)

public static final ConversationalSearchServiceClient create(ConversationalSearchServiceStub stub)

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

Parameter
NameDescription
stubConversationalSearchServiceStub
Returns
TypeDescription
ConversationalSearchServiceClient

Constructors

ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)

protected ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)

Constructs an instance of ConversationalSearchServiceClient, 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
NameDescription
settingsConversationalSearchServiceSettings

ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)

protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)
Parameter
NameDescription
stubConversationalSearchServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

converseConversation(ConversationName name, TextInput query)

public final ConverseConversationResponse converseConversation(ConversationName name, TextInput query)

Converses a conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationName name =
       ConversationName.ofProjectLocationDataStoreConversationName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
   TextInput query = TextInput.newBuilder().build();
   ConverseConversationResponse response =
       conversationalSearchServiceClient.converseConversation(name, query);
 }
 
Parameters
NameDescription
nameConversationName

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

queryTextInput

Required. Current user input.

Returns
TypeDescription
ConverseConversationResponse

converseConversation(ConverseConversationRequest request)

public final ConverseConversationResponse converseConversation(ConverseConversationRequest request)

Converses a conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConverseConversationRequest request =
       ConverseConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .setQuery(TextInput.newBuilder().build())
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setConversation(Conversation.newBuilder().build())
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.newBuilder().build())
           .setFilter("filter-1274492040")
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .build();
   ConverseConversationResponse response =
       conversationalSearchServiceClient.converseConversation(request);
 }
 
Parameter
NameDescription
requestConverseConversationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ConverseConversationResponse

converseConversation(String name, TextInput query)

public final ConverseConversationResponse converseConversation(String name, TextInput query)

Converses a conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   String name =
       ConversationName.ofProjectLocationDataStoreConversationName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
           .toString();
   TextInput query = TextInput.newBuilder().build();
   ConverseConversationResponse response =
       conversationalSearchServiceClient.converseConversation(name, query);
 }
 
Parameters
NameDescription
nameString

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

queryTextInput

Required. Current user input.

Returns
TypeDescription
ConverseConversationResponse

converseConversationCallable()

public final UnaryCallable<ConverseConversationRequest,ConverseConversationResponse> converseConversationCallable()

Converses a conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConverseConversationRequest request =
       ConverseConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .setQuery(TextInput.newBuilder().build())
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setConversation(Conversation.newBuilder().build())
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.newBuilder().build())
           .setFilter("filter-1274492040")
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .build();
   ApiFuture<ConverseConversationResponse> future =
       conversationalSearchServiceClient.converseConversationCallable().futureCall(request);
   // Do something.
   ConverseConversationResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ConverseConversationRequest,ConverseConversationResponse>

createConversation(CreateConversationRequest request)

public final Conversation createConversation(CreateConversationRequest request)

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setConversation(Conversation.newBuilder().build())
           .build();
   Conversation response = conversationalSearchServiceClient.createConversation(request);
 }
 
Parameter
NameDescription
requestCreateConversationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Conversation

createConversation(DataStoreName parent, Conversation conversation)

public final Conversation createConversation(DataStoreName parent, Conversation conversation)

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response =
       conversationalSearchServiceClient.createConversation(parent, conversation);
 }
 
Parameters
NameDescription
parentDataStoreName

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

conversationConversation

Required. The conversation to create.

Returns
TypeDescription
Conversation

createConversation(String parent, Conversation conversation)

public final Conversation createConversation(String parent, Conversation conversation)

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response =
       conversationalSearchServiceClient.createConversation(parent, conversation);
 }
 
Parameters
NameDescription
parentString

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

conversationConversation

Required. The conversation to create.

Returns
TypeDescription
Conversation

createConversationCallable()

public final UnaryCallable<CreateConversationRequest,Conversation> createConversationCallable()

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setConversation(Conversation.newBuilder().build())
           .build();
   ApiFuture<Conversation> future =
       conversationalSearchServiceClient.createConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateConversationRequest,Conversation>

deleteConversation(ConversationName name)

public final void deleteConversation(ConversationName name)

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationName name =
       ConversationName.ofProjectLocationDataStoreConversationName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
   conversationalSearchServiceClient.deleteConversation(name);
 }
 
Parameter
NameDescription
nameConversationName

Required. The resource name of the Conversation to delete. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

deleteConversation(DeleteConversationRequest request)

public final void deleteConversation(DeleteConversationRequest request)

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   DeleteConversationRequest request =
       DeleteConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .build();
   conversationalSearchServiceClient.deleteConversation(request);
 }
 
Parameter
NameDescription
requestDeleteConversationRequest

The request object containing all of the parameters for the API call.

deleteConversation(String name)

public final void deleteConversation(String name)

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   String name =
       ConversationName.ofProjectLocationDataStoreConversationName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
           .toString();
   conversationalSearchServiceClient.deleteConversation(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the Conversation to delete. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

deleteConversationCallable()

public final UnaryCallable<DeleteConversationRequest,Empty> deleteConversationCallable()

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   DeleteConversationRequest request =
       DeleteConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       conversationalSearchServiceClient.deleteConversationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteConversationRequest,Empty>

getConversation(ConversationName name)

public final Conversation getConversation(ConversationName name)

Gets a Conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationName name =
       ConversationName.ofProjectLocationDataStoreConversationName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
   Conversation response = conversationalSearchServiceClient.getConversation(name);
 }
 
Parameter
NameDescription
nameConversationName

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

Returns
TypeDescription
Conversation

getConversation(GetConversationRequest request)

public final Conversation getConversation(GetConversationRequest request)

Gets a Conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   GetConversationRequest request =
       GetConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .build();
   Conversation response = conversationalSearchServiceClient.getConversation(request);
 }
 
Parameter
NameDescription
requestGetConversationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Conversation

getConversation(String name)

public final Conversation getConversation(String name)

Gets a Conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   String name =
       ConversationName.ofProjectLocationDataStoreConversationName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
           .toString();
   Conversation response = conversationalSearchServiceClient.getConversation(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

Returns
TypeDescription
Conversation

getConversationCallable()

public final UnaryCallable<GetConversationRequest,Conversation> getConversationCallable()

Gets a Conversation.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   GetConversationRequest request =
       GetConversationRequest.newBuilder()
           .setName(
               ConversationName.ofProjectLocationDataStoreConversationName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]")
                   .toString())
           .build();
   ApiFuture<Conversation> future =
       conversationalSearchServiceClient.getConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetConversationRequest,Conversation>

getSettings()

public final ConversationalSearchServiceSettings getSettings()
Returns
TypeDescription
ConversationalSearchServiceSettings

getStub()

public ConversationalSearchServiceStub getStub()
Returns
TypeDescription
ConversationalSearchServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listConversations(DataStoreName parent)

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(DataStoreName parent)

Lists all Conversations by their parent DataStore.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (Conversation element :
       conversationalSearchServiceClient.listConversations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentDataStoreName

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

Returns
TypeDescription
ConversationalSearchServiceClient.ListConversationsPagedResponse

listConversations(ListConversationsRequest request)

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(ListConversationsRequest request)

Lists all Conversations by their parent DataStore.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Conversation element :
       conversationalSearchServiceClient.listConversations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListConversationsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ConversationalSearchServiceClient.ListConversationsPagedResponse

listConversations(String parent)

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(String parent)

Lists all Conversations by their parent DataStore.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (Conversation element :
       conversationalSearchServiceClient.listConversations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

Returns
TypeDescription
ConversationalSearchServiceClient.ListConversationsPagedResponse

listConversationsCallable()

public final UnaryCallable<ListConversationsRequest,ListConversationsResponse> listConversationsCallable()

Lists all Conversations by their parent DataStore.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListConversationsResponse response =
         conversationalSearchServiceClient.listConversationsCallable().call(request);
     for (Conversation element : response.getConversationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListConversationsRequest,ListConversationsResponse>

listConversationsPagedCallable()

public final UnaryCallable<ListConversationsRequest,ConversationalSearchServiceClient.ListConversationsPagedResponse> listConversationsPagedCallable()

Lists all Conversations by their parent DataStore.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Conversation> future =
       conversationalSearchServiceClient.listConversationsPagedCallable().futureCall(request);
   // Do something.
   for (Conversation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListConversationsRequest,ListConversationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateConversation(Conversation conversation, FieldMask updateMask)

public final Conversation updateConversation(Conversation conversation, FieldMask updateMask)

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   Conversation conversation = Conversation.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Conversation response =
       conversationalSearchServiceClient.updateConversation(conversation, updateMask);
 }
 
Parameters
NameDescription
conversationConversation

Required. The Conversation to update.

updateMaskFieldMask

Indicates which fields in the provided Conversation to update. The following are NOT supported:

  • Conversation.name

If not set or empty, all supported fields are updated.

Returns
TypeDescription
Conversation

updateConversation(UpdateConversationRequest request)

public final Conversation updateConversation(UpdateConversationRequest request)

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   UpdateConversationRequest request =
       UpdateConversationRequest.newBuilder()
           .setConversation(Conversation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Conversation response = conversationalSearchServiceClient.updateConversation(request);
 }
 
Parameter
NameDescription
requestUpdateConversationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Conversation

updateConversationCallable()

public final UnaryCallable<UpdateConversationRequest,Conversation> updateConversationCallable()

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   UpdateConversationRequest request =
       UpdateConversationRequest.newBuilder()
           .setConversation(Conversation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Conversation> future =
       conversationalSearchServiceClient.updateConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateConversationRequest,Conversation>