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(). + * + *
The surface of this class includes several types of Java methods for each of the API's + * methods: + * + *
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. + */ +@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())
+ * .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())
+ * .build();
+ * ApiFuture future =
+ * conversationalSearchServiceClient.converseConversationCallable().futureCall(request);
+ * // Do something.
+ * ConverseConversationResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableIf the [Conversation][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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 UnaryCallableIf the [Conversation][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. + * If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a + * NOT_FOUND error is returned. + * + *
Sample code: + * + *
{@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.v1.Conversation] to update. The following are
+ * NOT supported:
+ * 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.v1.Conversation] action type cannot be changed. + * If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a + * NOT_FOUND error is returned. + * + *
Sample code: + * + *
{@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.v1.Conversation] action type cannot be changed. + * If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a + * NOT_FOUND error is returned. + * + *
Sample code: + * + *
{@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 UnaryCallableSample 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 UnaryCallableSample 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.v1.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.v1.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.v1.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 UnaryCallableSample 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 UnaryCallableThe default instance has everything set to sensible defaults: + * + *
The builder of this class is recursive, so contained classes are themselves builders. When + * build() is called, the tree of builders is called to create the complete settings object. + * + *
For example, to set the total timeout of converseConversation to 30 seconds: + * + *
{@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.Builder conversationalSearchServiceSettingsBuilder =
+ * ConversationalSearchServiceSettings.newBuilder();
+ * conversationalSearchServiceSettingsBuilder
+ * .converseConversationSettings()
+ * .setRetrySettings(
+ * conversationalSearchServiceSettingsBuilder
+ * .converseConversationSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * ConversationalSearchServiceSettings conversationalSearchServiceSettings =
+ * conversationalSearchServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class ConversationalSearchServiceSettings
+ extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction If the caller does not have permission to list [Documents][]s under this branch,
- * regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
+ * If the caller does not have permission to list
+ * [Document][google.cloud.discoveryengine.v1.Document]s under this branch, regardless of
+ * whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDocumentsPagedResponse listDocuments(BranchName parent) {
@@ -405,8 +406,9 @@ public final ListDocumentsPagedResponse listDocuments(BranchName parent) {
* @param parent Required. The parent branch resource name, such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
* Use `default_branch` as the branch ID, to list documents under the default branch.
- * If the caller does not have permission to list [Documents][]s under this branch,
- * regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
+ * If the caller does not have permission to list
+ * [Document][google.cloud.discoveryengine.v1.Document]s under this branch, regardless of
+ * whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDocumentsPagedResponse listDocuments(String parent) {
diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/SearchServiceClient.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/SearchServiceClient.java
index ba53e6def7a4..6c134915e51e 100644
--- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/SearchServiceClient.java
+++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/SearchServiceClient.java
@@ -57,10 +57,15 @@
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
* .toString())
* .setQuery("query107944136")
+ * .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setOffset(-1019779949)
+ * .setFilter("filter-1274492040")
+ * .setOrderBy("orderBy-1207110587")
* .setUserInfo(UserInfo.newBuilder().build())
+ * .addAllFacetSpecs(new ArrayList This method is used only by the Discovery Engine API JavaScript pixel and Google Tag
* Manager. Users should not call this method directly.
@@ -310,7 +310,7 @@ public final HttpBody collectUserEvent(CollectUserEventRequest request) {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Writes a single user event from the browser. This uses a GET request to due to browser
- * restriction of POST-ing to a 3rd party domain.
+ * restriction of POST-ing to a third-party domain.
*
* This method is used only by the Discovery Engine API JavaScript pixel and Google Tag
* Manager. Users should not call this method directly.
diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/gapic_metadata.json b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/gapic_metadata.json
index 07b306ce2c0a..4fb8e738cf19 100644
--- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/gapic_metadata.json
+++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/gapic_metadata.json
@@ -17,6 +17,33 @@
}
}
},
+ "ConversationalSearchService": {
+ "clients": {
+ "grpc": {
+ "libraryClient": "ConversationalSearchServiceClient",
+ "rpcs": {
+ "ConverseConversation": {
+ "methods": ["converseConversation", "converseConversation", "converseConversation", "converseConversationCallable"]
+ },
+ "CreateConversation": {
+ "methods": ["createConversation", "createConversation", "createConversation", "createConversationCallable"]
+ },
+ "DeleteConversation": {
+ "methods": ["deleteConversation", "deleteConversation", "deleteConversation", "deleteConversationCallable"]
+ },
+ "GetConversation": {
+ "methods": ["getConversation", "getConversation", "getConversation", "getConversationCallable"]
+ },
+ "ListConversations": {
+ "methods": ["listConversations", "listConversations", "listConversations", "listConversationsPagedCallable", "listConversationsCallable"]
+ },
+ "UpdateConversation": {
+ "methods": ["updateConversation", "updateConversation", "updateConversationCallable"]
+ }
+ }
+ }
+ }
+ },
"DocumentService": {
"clients": {
"grpc": {
diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/package-info.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/package-info.java
index 011db3d84b21..1fe403cbeb05 100644
--- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/package-info.java
+++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1/package-info.java
@@ -41,11 +41,35 @@
* .setQuery("query107944136")
* .setQueryModel("queryModel-184930495")
* .setUserPseudoId("userPseudoId-1155274652")
+ * .setIncludeTailSuggestions(true)
* .build();
* CompleteQueryResponse response = completionServiceClient.completeQuery(request);
* }
* }
*
+ * ======================= ConversationalSearchServiceClient =======================
+ *
+ * Service Description: Service for conversational search.
+ *
+ * Sample for ConversationalSearchServiceClient:
+ *
+ * ======================= DocumentServiceClient =======================
*
* Service Description: Service for ingesting
@@ -111,10 +135,15 @@
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
* .toString())
* .setQuery("query107944136")
+ * .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setOffset(-1019779949)
+ * .setFilter("filter-1274492040")
+ * .setOrderBy("orderBy-1207110587")
* .setUserInfo(UserInfo.newBuilder().build())
+ * .addAllFacetSpecs(new ArrayList This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public abstract class ConversationalSearchServiceStub implements BackgroundResource {
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of converseConversation to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcConversationalSearchServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcConversationalSearchServiceStub extends ConversationalSearchServiceStub {
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+@BetaApi
+public class HttpJsonConversationalSearchServiceCallableFactory
+ implements HttpJsonStubCallableFactory This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+@BetaApi
+public class HttpJsonConversationalSearchServiceStub extends ConversationalSearchServiceStub {
+ private static final TypeRegistry typeRegistry = TypeRegistry.newBuilder().build();
+
+ private static final ApiMethodDescriptor<
+ ConverseConversationRequest, ConverseConversationResponse>
+ converseConversationMethodDescriptor =
+ ApiMethodDescriptor
+ .{@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);
+ * }
+ * }
+ *
*
+ *
+ *
+ * {@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
+ * ConversationalSearchServiceStubSettings.Builder conversationalSearchServiceSettingsBuilder =
+ * ConversationalSearchServiceStubSettings.newBuilder();
+ * conversationalSearchServiceSettingsBuilder
+ * .converseConversationSettings()
+ * .setRetrySettings(
+ * conversationalSearchServiceSettingsBuilder
+ * .converseConversationSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * ConversationalSearchServiceStubSettings conversationalSearchServiceSettings =
+ * conversationalSearchServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class ConversationalSearchServiceStubSettings
+ extends StubSettings