- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public class ConversationalSearchServiceClient implements 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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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.
Implements
BackgroundResourceStatic Methods
create()
public static final ConversationalSearchServiceClient create()
Constructs an instance of ConversationalSearchServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ConversationalSearchServiceClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | ConversationalSearchServiceSettings |
Returns | |
---|---|
Type | Description |
ConversationalSearchServiceClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
stub | ConversationalSearchServiceStub |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | ConversationalSearchServiceSettings |
ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)
protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | ConversationalSearchServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
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 | |
---|---|
Name | Description |
name | ConversationName Required. The resource name of the Conversation to get. Format:
|
query | TextInput Required. Current user input. |
Returns | |
---|---|
Type | Description |
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())
.build();
ConverseConversationResponse response =
conversationalSearchServiceClient.converseConversation(request);
}
Parameter | |
---|---|
Name | Description |
request | ConverseConversationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | String Required. The resource name of the Conversation to get. Format:
|
query | TextInput Required. Current user input. |
Returns | |
---|---|
Type | Description |
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())
.build();
ApiFuture<ConverseConversationResponse> future =
conversationalSearchServiceClient.converseConversationCallable().futureCall(request);
// Do something.
ConverseConversationResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | CreateConversationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | DataStoreName Required. Full resource name of parent data store. Format:
|
conversation | Conversation Required. The conversation to create. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | String Required. Full resource name of parent data store. Format:
|
conversation | Conversation Required. The conversation to create. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | ConversationName Required. The resource name of the Conversation to delete. Format:
|
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 | |
---|---|
Name | Description |
request | DeleteConversationRequest 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 | |
---|---|
Name | Description |
name | String Required. The resource name of the Conversation to delete. Format:
|
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | ConversationName Required. The resource name of the Conversation to get. Format:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | GetConversationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | String Required. The resource name of the Conversation to get. Format:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
UnaryCallable<GetConversationRequest,Conversation> |
getSettings()
public final ConversationalSearchServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ConversationalSearchServiceSettings |
getStub()
public ConversationalSearchServiceStub getStub()
Returns | |
---|---|
Type | Description |
ConversationalSearchServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | DataStoreName Required. The data store resource name. Format:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | ListConversationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | String Required. The data store resource name. Format:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
conversation | Conversation Required. The Conversation to update. |
updateMask | FieldMask Indicates which fields in the provided Conversation to update. The following are NOT supported:
If not set or empty, all supported fields are updated. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | UpdateConversationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
UnaryCallable<UpdateConversationRequest,Conversation> |