com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-discoveryengine Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.discoveryengine.v1beta;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.discoveryengine.v1beta.stub.ConversationalSearchServiceStub;
import com.google.cloud.discoveryengine.v1beta.stub.ConversationalSearchServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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.v1beta.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.v1beta.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.v1beta.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1beta.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.v1beta.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()
*
*
*
*
* AnswerQuery
* Answer query method.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* answerQuery(AnswerQueryRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* answerQueryCallable()
*
*
*
*
* GetAnswer
* Gets a Answer.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getAnswer(GetAnswerRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getAnswer(AnswerName name)
*
getAnswer(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.
*
* getAnswerCallable()
*
*
*
*
* CreateSession
* Creates a Session.
*
If the [Session][google.cloud.discoveryengine.v1beta.Session] 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.
*
* createSession(CreateSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createSession(DataStoreName parent, Session session)
*
createSession(String parent, Session session)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createSessionCallable()
*
*
*
*
* DeleteSession
* Deletes a Session.
*
If the [Session][google.cloud.discoveryengine.v1beta.Session] 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.
*
* deleteSession(DeleteSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteSession(SessionName name)
*
deleteSession(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.
*
* deleteSessionCallable()
*
*
*
*
* UpdateSession
* Updates a Session.
*
[Session][google.cloud.discoveryengine.v1beta.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session] 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.
*
* updateSession(UpdateSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateSession(Session session, 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.
*
* updateSessionCallable()
*
*
*
*
* GetSession
* Gets a Session.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getSession(GetSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getSession(SessionName name)
*
getSession(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.
*
* getSessionCallable()
*
*
*
*
* ListSessions
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listSessions(ListSessionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listSessions(DataStoreName parent)
*
listSessions(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.
*
* listSessionsPagedCallable()
*
listSessionsCallable()
*
*
*
*
*
* 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:
*
*
{@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
* ConversationalSearchServiceSettings conversationalSearchServiceSettings =
* ConversationalSearchServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ConversationalSearchServiceClient conversationalSearchServiceClient =
* ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* ConversationalSearchServiceSettings conversationalSearchServiceSettings =
* ConversationalSearchServiceSettings.newHttpJsonBuilder().build();
* ConversationalSearchServiceClient conversationalSearchServiceClient =
* ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class ConversationalSearchServiceClient implements BackgroundResource {
private final ConversationalSearchServiceSettings settings;
private final ConversationalSearchServiceStub stub;
/** Constructs an instance of ConversationalSearchServiceClient with default settings. */
public static final ConversationalSearchServiceClient create() throws IOException {
return create(ConversationalSearchServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final ConversationalSearchServiceClient create(
ConversationalSearchServiceSettings settings) throws IOException {
return new ConversationalSearchServiceClient(settings);
}
/**
* Constructs an instance of ConversationalSearchServiceClient, using the given stub for making
* calls. This is for advanced usage - prefer using create(ConversationalSearchServiceSettings).
*/
public static final ConversationalSearchServiceClient create(
ConversationalSearchServiceStub stub) {
return new ConversationalSearchServiceClient(stub);
}
/**
* 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.
*/
protected ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((ConversationalSearchServiceStubSettings) settings.getStubSettings()).createStub();
}
protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final ConversationalSearchServiceSettings getSettings() {
return settings;
}
public ConversationalSearchServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Converses a conversation.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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.
* @param query Required. Current user input.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ConverseConversationResponse converseConversation(
ConversationName name, TextInput query) {
ConverseConversationRequest request =
ConverseConversationRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setQuery(query)
.build();
return converseConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Converses a conversation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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.
* @param query Required. Current user input.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ConverseConversationResponse converseConversation(String name, TextInput query) {
ConverseConversationRequest request =
ConverseConversationRequest.newBuilder().setName(name).setQuery(query).build();
return converseConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Converses a conversation.
*
* Sample code:
*
*
{@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())
* .setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.newBuilder().build())
* .setFilter("filter-1274492040")
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
* .build();
* ConverseConversationResponse response =
* conversationalSearchServiceClient.converseConversation(request);
* }
* }
*
* @param 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
*/
public final ConverseConversationResponse converseConversation(
ConverseConversationRequest request) {
return converseConversationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Converses a conversation.
*
* Sample code:
*
*
{@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())
* .setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.newBuilder().build())
* .setFilter("filter-1274492040")
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.converseConversationCallable().futureCall(request);
* // Do something.
* ConverseConversationResponse response = future.get();
* }
* }
*/
public final UnaryCallable
converseConversationCallable() {
return stub.converseConversationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to create already
* exists, an ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. Full resource name of parent data store. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
* @param conversation Required. The conversation to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Conversation createConversation(DataStoreName parent, Conversation conversation) {
CreateConversationRequest request =
CreateConversationRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setConversation(conversation)
.build();
return createConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to create already
* exists, an ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. Full resource name of parent data store. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
* @param conversation Required. The conversation to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Conversation createConversation(String parent, Conversation conversation) {
CreateConversationRequest request =
CreateConversationRequest.newBuilder()
.setParent(parent)
.setConversation(conversation)
.build();
return createConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to create already
* exists, an ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Conversation createConversation(CreateConversationRequest request) {
return createConversationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to create already
* exists, an ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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 future =
* conversationalSearchServiceClient.createConversationCallable().futureCall(request);
* // Do something.
* Conversation response = future.get();
* }
* }
*/
public final UnaryCallable createConversationCallable() {
return stub.createConversationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to delete does not
* exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteConversation(ConversationName name) {
DeleteConversationRequest request =
DeleteConversationRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to delete does not
* exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteConversation(String name) {
DeleteConversationRequest request =
DeleteConversationRequest.newBuilder().setName(name).build();
deleteConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to delete does not
* exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteConversation(DeleteConversationRequest request) {
deleteConversationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Conversation.
*
* If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to delete does not
* exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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 future =
* conversationalSearchServiceClient.deleteConversationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteConversationCallable() {
return stub.deleteConversationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Conversation.
*
* [Conversation][google.cloud.discoveryengine.v1beta.Conversation] action type cannot be
* changed. If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update does
* not exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param conversation Required. The Conversation to update.
* @param updateMask Indicates which fields in the provided
* [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update. The following
* are NOT supported:
*
* - [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name]
*
* If not set or empty, all supported fields are updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Conversation updateConversation(Conversation conversation, FieldMask updateMask) {
UpdateConversationRequest request =
UpdateConversationRequest.newBuilder()
.setConversation(conversation)
.setUpdateMask(updateMask)
.build();
return updateConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Conversation.
*
*
[Conversation][google.cloud.discoveryengine.v1beta.Conversation] action type cannot be
* changed. If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update does
* not exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Conversation updateConversation(UpdateConversationRequest request) {
return updateConversationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Conversation.
*
* [Conversation][google.cloud.discoveryengine.v1beta.Conversation] action type cannot be
* changed. If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update does
* not exist, a NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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 future =
* conversationalSearchServiceClient.updateConversationCallable().futureCall(request);
* // Do something.
* Conversation response = future.get();
* }
* }
*/
public final UnaryCallable updateConversationCallable() {
return stub.updateConversationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Conversation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Conversation getConversation(ConversationName name) {
GetConversationRequest request =
GetConversationRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Conversation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Conversation getConversation(String name) {
GetConversationRequest request = GetConversationRequest.newBuilder().setName(name).build();
return getConversation(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Conversation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Conversation getConversation(GetConversationRequest request) {
return getConversationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Conversation.
*
* Sample code:
*
*
{@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 future =
* conversationalSearchServiceClient.getConversationCallable().futureCall(request);
* // Do something.
* Conversation response = future.get();
* }
* }
*/
public final UnaryCallable getConversationCallable() {
return stub.getConversationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Conversations by their parent
* [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListConversationsPagedResponse listConversations(DataStoreName parent) {
ListConversationsRequest request =
ListConversationsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listConversations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Conversations by their parent
* [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListConversationsPagedResponse listConversations(String parent) {
ListConversationsRequest request =
ListConversationsRequest.newBuilder().setParent(parent).build();
return listConversations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Conversations by their parent
* [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListConversationsPagedResponse listConversations(ListConversationsRequest request) {
return listConversationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Conversations by their parent
* [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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 future =
* conversationalSearchServiceClient.listConversationsPagedCallable().futureCall(request);
* // Do something.
* for (Conversation element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listConversationsPagedCallable() {
return stub.listConversationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Conversations by their parent
* [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable
listConversationsCallable() {
return stub.listConversationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Answer query method.
*
* Sample code:
*
*
{@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()) {
* AnswerQueryRequest request =
* AnswerQueryRequest.newBuilder()
* .setServingConfig(
* ServingConfigName.ofProjectLocationDataStoreServingConfigName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
* .toString())
* .setQuery(Query.newBuilder().build())
* .setSession(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .setSafetySpec(AnswerQueryRequest.SafetySpec.newBuilder().build())
* .setRelatedQuestionsSpec(AnswerQueryRequest.RelatedQuestionsSpec.newBuilder().build())
* .setAnswerGenerationSpec(AnswerQueryRequest.AnswerGenerationSpec.newBuilder().build())
* .setSearchSpec(AnswerQueryRequest.SearchSpec.newBuilder().build())
* .setQueryUnderstandingSpec(
* AnswerQueryRequest.QueryUnderstandingSpec.newBuilder().build())
* .setAsynchronousMode(true)
* .setUserPseudoId("userPseudoId-1155274652")
* .putAllUserLabels(new HashMap())
* .build();
* AnswerQueryResponse response = conversationalSearchServiceClient.answerQuery(request);
* }
* }
*
* @param 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
*/
public final AnswerQueryResponse answerQuery(AnswerQueryRequest request) {
return answerQueryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Answer query method.
*
* Sample code:
*
*
{@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()) {
* AnswerQueryRequest request =
* AnswerQueryRequest.newBuilder()
* .setServingConfig(
* ServingConfigName.ofProjectLocationDataStoreServingConfigName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
* .toString())
* .setQuery(Query.newBuilder().build())
* .setSession(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .setSafetySpec(AnswerQueryRequest.SafetySpec.newBuilder().build())
* .setRelatedQuestionsSpec(AnswerQueryRequest.RelatedQuestionsSpec.newBuilder().build())
* .setAnswerGenerationSpec(AnswerQueryRequest.AnswerGenerationSpec.newBuilder().build())
* .setSearchSpec(AnswerQueryRequest.SearchSpec.newBuilder().build())
* .setQueryUnderstandingSpec(
* AnswerQueryRequest.QueryUnderstandingSpec.newBuilder().build())
* .setAsynchronousMode(true)
* .setUserPseudoId("userPseudoId-1155274652")
* .putAllUserLabels(new HashMap())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.answerQueryCallable().futureCall(request);
* // Do something.
* AnswerQueryResponse response = future.get();
* }
* }
*/
public final UnaryCallable answerQueryCallable() {
return stub.answerQueryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Answer.
*
* Sample code:
*
*
{@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()) {
* AnswerName name =
* AnswerName.ofProjectLocationDataStoreSessionAnswerName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]", "[ANSWER]");
* Answer response = conversationalSearchServiceClient.getAnswer(name);
* }
* }
*
* @param name Required. The resource name of the Answer to get. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Answer getAnswer(AnswerName name) {
GetAnswerRequest request =
GetAnswerRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getAnswer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Answer.
*
* Sample code:
*
*
{@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 =
* AnswerName.ofProjectLocationDataStoreSessionAnswerName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]", "[ANSWER]")
* .toString();
* Answer response = conversationalSearchServiceClient.getAnswer(name);
* }
* }
*
* @param name Required. The resource name of the Answer to get. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Answer getAnswer(String name) {
GetAnswerRequest request = GetAnswerRequest.newBuilder().setName(name).build();
return getAnswer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Answer.
*
* Sample code:
*
*
{@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()) {
* GetAnswerRequest request =
* GetAnswerRequest.newBuilder()
* .setName(
* AnswerName.ofProjectLocationDataStoreSessionAnswerName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]", "[ANSWER]")
* .toString())
* .build();
* Answer response = conversationalSearchServiceClient.getAnswer(request);
* }
* }
*
* @param 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
*/
public final Answer getAnswer(GetAnswerRequest request) {
return getAnswerCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Answer.
*
* Sample code:
*
*
{@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()) {
* GetAnswerRequest request =
* GetAnswerRequest.newBuilder()
* .setName(
* AnswerName.ofProjectLocationDataStoreSessionAnswerName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]", "[ANSWER]")
* .toString())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.getAnswerCallable().futureCall(request);
* // Do something.
* Answer response = future.get();
* }
* }
*/
public final UnaryCallable getAnswerCallable() {
return stub.getAnswerCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to create already exists, an
* ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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]");
* Session session = Session.newBuilder().build();
* Session response = conversationalSearchServiceClient.createSession(parent, session);
* }
* }
*
* @param parent Required. Full resource name of parent data store. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
* @param session Required. The session to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session createSession(DataStoreName parent, Session session) {
CreateSessionRequest request =
CreateSessionRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setSession(session)
.build();
return createSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to create already exists, an
* ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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();
* Session session = Session.newBuilder().build();
* Session response = conversationalSearchServiceClient.createSession(parent, session);
* }
* }
*
* @param parent Required. Full resource name of parent data store. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
* @param session Required. The session to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session createSession(String parent, Session session) {
CreateSessionRequest request =
CreateSessionRequest.newBuilder().setParent(parent).setSession(session).build();
return createSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to create already exists, an
* ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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()) {
* CreateSessionRequest request =
* CreateSessionRequest.newBuilder()
* .setParent(
* DataStoreName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setSession(Session.newBuilder().build())
* .build();
* Session response = conversationalSearchServiceClient.createSession(request);
* }
* }
*
* @param 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
*/
public final Session createSession(CreateSessionRequest request) {
return createSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to create already exists, an
* ALREADY_EXISTS error is returned.
*
*
Sample code:
*
*
{@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()) {
* CreateSessionRequest request =
* CreateSessionRequest.newBuilder()
* .setParent(
* DataStoreName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setSession(Session.newBuilder().build())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.createSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable createSessionCallable() {
return stub.createSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete does not exist, a
* NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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()) {
* SessionName name =
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]");
* conversationalSearchServiceClient.deleteSession(name);
* }
* }
*
* @param name Required. The resource name of the Session to delete. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSession(SessionName name) {
DeleteSessionRequest request =
DeleteSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete does not exist, a
* NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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 =
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString();
* conversationalSearchServiceClient.deleteSession(name);
* }
* }
*
* @param name Required. The resource name of the Session to delete. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSession(String name) {
DeleteSessionRequest request = DeleteSessionRequest.newBuilder().setName(name).build();
deleteSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete does not exist, a
* NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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()) {
* DeleteSessionRequest request =
* DeleteSessionRequest.newBuilder()
* .setName(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .build();
* conversationalSearchServiceClient.deleteSession(request);
* }
* }
*
* @param 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
*/
public final void deleteSession(DeleteSessionRequest request) {
deleteSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Session.
*
* If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete does not exist, a
* NOT_FOUND error is returned.
*
*
Sample code:
*
*
{@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()) {
* DeleteSessionRequest request =
* DeleteSessionRequest.newBuilder()
* .setName(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.deleteSessionCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteSessionCallable() {
return stub.deleteSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Session.
*
* [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot be changed. If the
* [Session][google.cloud.discoveryengine.v1beta.Session] to update does not exist, a NOT_FOUND
* error is returned.
*
*
Sample code:
*
*
{@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()) {
* Session session = Session.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Session response = conversationalSearchServiceClient.updateSession(session, updateMask);
* }
* }
*
* @param session Required. The Session to update.
* @param updateMask Indicates which fields in the provided
* [Session][google.cloud.discoveryengine.v1beta.Session] to update. The following are NOT
* supported:
*
* - [Session.name][google.cloud.discoveryengine.v1beta.Session.name]
*
* If not set or empty, all supported fields are updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session updateSession(Session session, FieldMask updateMask) {
UpdateSessionRequest request =
UpdateSessionRequest.newBuilder().setSession(session).setUpdateMask(updateMask).build();
return updateSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Session.
*
*
[Session][google.cloud.discoveryengine.v1beta.Session] action type cannot be changed. If the
* [Session][google.cloud.discoveryengine.v1beta.Session] to update does not exist, a NOT_FOUND
* error is returned.
*
*
Sample code:
*
*
{@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()) {
* UpdateSessionRequest request =
* UpdateSessionRequest.newBuilder()
* .setSession(Session.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Session response = conversationalSearchServiceClient.updateSession(request);
* }
* }
*
* @param 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
*/
public final Session updateSession(UpdateSessionRequest request) {
return updateSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Session.
*
* [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot be changed. If the
* [Session][google.cloud.discoveryengine.v1beta.Session] to update does not exist, a NOT_FOUND
* error is returned.
*
*
Sample code:
*
*
{@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()) {
* UpdateSessionRequest request =
* UpdateSessionRequest.newBuilder()
* .setSession(Session.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.updateSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable updateSessionCallable() {
return stub.updateSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Session.
*
* Sample code:
*
*
{@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()) {
* SessionName name =
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]");
* Session response = conversationalSearchServiceClient.getSession(name);
* }
* }
*
* @param name Required. The resource name of the Session to get. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(SessionName name) {
GetSessionRequest request =
GetSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Session.
*
* Sample code:
*
*
{@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 =
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString();
* Session response = conversationalSearchServiceClient.getSession(name);
* }
* }
*
* @param name Required. The resource name of the Session to get. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(String name) {
GetSessionRequest request = GetSessionRequest.newBuilder().setName(name).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Session.
*
* Sample code:
*
*
{@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()) {
* GetSessionRequest request =
* GetSessionRequest.newBuilder()
* .setName(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .build();
* Session response = conversationalSearchServiceClient.getSession(request);
* }
* }
*
* @param 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
*/
public final Session getSession(GetSessionRequest request) {
return getSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Session.
*
* Sample code:
*
*
{@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()) {
* GetSessionRequest request =
* GetSessionRequest.newBuilder()
* .setName(
* SessionName.ofProjectLocationDataStoreSessionName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
* .toString())
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.getSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable getSessionCallable() {
return stub.getSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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 (Session element : conversationalSearchServiceClient.listSessions(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListSessionsPagedResponse listSessions(DataStoreName parent) {
ListSessionsRequest request =
ListSessionsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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 (Session element : conversationalSearchServiceClient.listSessions(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListSessionsPagedResponse listSessions(String parent) {
ListSessionsRequest request = ListSessionsRequest.newBuilder().setParent(parent).build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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()) {
* ListSessionsRequest request =
* ListSessionsRequest.newBuilder()
* .setParent(
* DataStoreName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* for (Session element : conversationalSearchServiceClient.listSessions(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListSessionsPagedResponse listSessions(ListSessionsRequest request) {
return listSessionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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()) {
* ListSessionsRequest request =
* ListSessionsRequest.newBuilder()
* .setParent(
* DataStoreName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* ApiFuture future =
* conversationalSearchServiceClient.listSessionsPagedCallable().futureCall(request);
* // Do something.
* for (Session element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listSessionsPagedCallable() {
return stub.listSessionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
*
* Sample code:
*
*
{@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()) {
* ListSessionsRequest request =
* ListSessionsRequest.newBuilder()
* .setParent(
* DataStoreName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* while (true) {
* ListSessionsResponse response =
* conversationalSearchServiceClient.listSessionsCallable().call(request);
* for (Session element : response.getSessionsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listSessionsCallable() {
return stub.listSessionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListConversationsPagedResponse
extends AbstractPagedListResponse<
ListConversationsRequest,
ListConversationsResponse,
Conversation,
ListConversationsPage,
ListConversationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListConversationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListConversationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListConversationsPagedResponse(ListConversationsPage page) {
super(page, ListConversationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListConversationsPage
extends AbstractPage<
ListConversationsRequest,
ListConversationsResponse,
Conversation,
ListConversationsPage> {
private ListConversationsPage(
PageContext context,
ListConversationsResponse response) {
super(context, response);
}
private static ListConversationsPage createEmptyPage() {
return new ListConversationsPage(null, null);
}
@Override
protected ListConversationsPage createPage(
PageContext context,
ListConversationsResponse response) {
return new ListConversationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListConversationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListConversationsRequest,
ListConversationsResponse,
Conversation,
ListConversationsPage,
ListConversationsFixedSizeCollection> {
private ListConversationsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListConversationsFixedSizeCollection createEmptyCollection() {
return new ListConversationsFixedSizeCollection(null, 0);
}
@Override
protected ListConversationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListConversationsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListSessionsPagedResponse
extends AbstractPagedListResponse<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSessionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListSessionsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListSessionsPagedResponse(ListSessionsPage page) {
super(page, ListSessionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSessionsPage
extends AbstractPage {
private ListSessionsPage(
PageContext context,
ListSessionsResponse response) {
super(context, response);
}
private static ListSessionsPage createEmptyPage() {
return new ListSessionsPage(null, null);
}
@Override
protected ListSessionsPage createPage(
PageContext context,
ListSessionsResponse response) {
return new ListSessionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSessionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
private ListSessionsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSessionsFixedSizeCollection createEmptyCollection() {
return new ListSessionsFixedSizeCollection(null, 0);
}
@Override
protected ListSessionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSessionsFixedSizeCollection(pages, collectionSize);
}
}
}