com.google.cloud.discoveryengine.v1

Class ConversationalSearchServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.ConversationalSearchServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ConversationalSearchServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

Method	Description	Method 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][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConversationalSearchServiceClient.ListConversationsFixedSizeCollection
static class	ConversationalSearchServiceClient.ListConversationsPage
static class	ConversationalSearchServiceClient.ListConversationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings) Constructs an instance of ConversationalSearchServiceClient, using the given settings.
protected	ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
ConverseConversationResponse	converseConversation(ConversationName name, TextInput query) Converses a conversation.
ConverseConversationResponse	converseConversation(ConverseConversationRequest request) Converses a conversation.
ConverseConversationResponse	converseConversation(String name, TextInput query) Converses a conversation.
com.google.api.gax.rpc.UnaryCallable<ConverseConversationRequest,ConverseConversationResponse>	converseConversationCallable() Converses a conversation.
static ConversationalSearchServiceClient	create() Constructs an instance of ConversationalSearchServiceClient with default settings.
static ConversationalSearchServiceClient	create(ConversationalSearchServiceSettings settings) Constructs an instance of ConversationalSearchServiceClient, using the given settings.
static ConversationalSearchServiceClient	create(ConversationalSearchServiceStub stub) Constructs an instance of ConversationalSearchServiceClient, using the given stub for making calls.
Conversation	createConversation(CreateConversationRequest request) Creates a Conversation.
Conversation	createConversation(DataStoreName parent, Conversation conversation) Creates a Conversation.
Conversation	createConversation(String parent, Conversation conversation) Creates a Conversation.
com.google.api.gax.rpc.UnaryCallable<CreateConversationRequest,Conversation>	createConversationCallable() Creates a Conversation.
void	deleteConversation(ConversationName name) Deletes a Conversation.
void	deleteConversation(DeleteConversationRequest request) Deletes a Conversation.
void	deleteConversation(String name) Deletes a Conversation.
com.google.api.gax.rpc.UnaryCallable<DeleteConversationRequest,com.google.protobuf.Empty>	deleteConversationCallable() Deletes a Conversation.
Conversation	getConversation(ConversationName name) Gets a Conversation.
Conversation	getConversation(GetConversationRequest request) Gets a Conversation.
Conversation	getConversation(String name) Gets a Conversation.
com.google.api.gax.rpc.UnaryCallable<GetConversationRequest,Conversation>	getConversationCallable() Gets a Conversation.
ConversationalSearchServiceSettings	getSettings()
ConversationalSearchServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ConversationalSearchServiceClient.ListConversationsPagedResponse	listConversations(DataStoreName parent) Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
ConversationalSearchServiceClient.ListConversationsPagedResponse	listConversations(ListConversationsRequest request) Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
ConversationalSearchServiceClient.ListConversationsPagedResponse	listConversations(String parent) Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ListConversationsResponse>	listConversationsCallable() Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ConversationalSearchServiceClient.ListConversationsPagedResponse>	listConversationsPagedCallable() Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
void	shutdown()
void	shutdownNow()
Conversation	updateConversation(Conversation conversation, com.google.protobuf.FieldMask updateMask) Updates a Conversation.
Conversation	updateConversation(UpdateConversationRequest request) Updates a Conversation.
com.google.api.gax.rpc.UnaryCallable<UpdateConversationRequest,Conversation>	updateConversationCallable() Updates a Conversation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConversationalSearchServiceClient

protected ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)
                                     throws IOException

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.

Throws:

IOException

ConversationalSearchServiceClient

protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)

Method Detail

create

public static final ConversationalSearchServiceClient create()
                                                      throws IOException

Constructs an instance of ConversationalSearchServiceClient with default settings.

Throws:

IOException

create

public static final ConversationalSearchServiceClient create(ConversationalSearchServiceSettings settings)
                                                      throws IOException

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.

Throws:

IOException

create

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

getSettings

public final ConversationalSearchServiceSettings getSettings()

getStub

public ConversationalSearchServiceStub getStub()

converseConversation

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:

name - 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.

query - Required. Current user input.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

converseConversation

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:

name - 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.

query - Required. Current user input.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

converseConversation

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")
           .build();
   ConverseConversationResponse response =
       conversationalSearchServiceClient.converseConversation(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

converseConversationCallable

public final com.google.api.gax.rpc.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")
           .build();
   ApiFuture<ConverseConversationResponse> future =
       conversationalSearchServiceClient.converseConversationCallable().futureCall(request);
   // Do something.
   ConverseConversationResponse response = future.get();
 }
 

createConversation

public final Conversation createConversation(DataStoreName parent,
                                             Conversation conversation)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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:

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

conversation - Required. The conversation to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createConversation

public final Conversation createConversation(String parent,
                                             Conversation conversation)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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:

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

conversation - Required. The conversation to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createConversation

public final Conversation createConversation(CreateConversationRequest request)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createConversationCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateConversationRequest,Conversation> createConversationCallable()

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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();
 }
 

deleteConversation

public final void deleteConversation(ConversationName name)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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);
 }
 

Parameters:

name - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversation

public final void deleteConversation(String name)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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);
 }
 

Parameters:

name - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversation

public final void deleteConversation(DeleteConversationRequest request)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversationCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteConversationRequest,com.google.protobuf.Empty> deleteConversationCallable()

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.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();
 }
 

updateConversation

public final Conversation updateConversation(Conversation conversation,
                                             com.google.protobuf.FieldMask updateMask)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.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:

conversation - Required. The Conversation to update.

updateMask - Indicates which fields in the provided [Conversation][google.cloud.discoveryengine.v1.Conversation] to update. The following are NOT supported:

• [Conversation.name][google.cloud.discoveryengine.v1.Conversation.name]

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateConversation

public final Conversation updateConversation(UpdateConversationRequest request)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateConversationCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateConversationRequest,Conversation> updateConversationCallable()

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.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();
 }
 

getConversation

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);
 }
 

Parameters:

name - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getConversation

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);
 }
 

Parameters:

name - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getConversation

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getConversationCallable

public final com.google.api.gax.rpc.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();
 }
 

listConversations

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(DataStoreName parent)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listConversations

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(String parent)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listConversations

public final ConversationalSearchServiceClient.ListConversationsPagedResponse listConversations(ListConversationsRequest request)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listConversationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ConversationalSearchServiceClient.ListConversationsPagedResponse> listConversationsPagedCallable()

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.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);
   }
 }
 

listConversationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ListConversationsResponse> listConversationsCallable()

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException