Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: [discoveryengine] add v1alpha public library for discoveryengine (
#9953) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 572280880 Source-Link: https://togithub.com/googleapis/googleapis/commit/f5cacaf0364606541f64c26e87370214f1199907 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/036171b68de5829f5cfa92949484cfcb7f00af28 Copy-Tag: eyJwIjoiamF2YS1kaXNjb3ZlcnllbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjAzNjE3MWI2OGRlNTgyOWY1Y2ZhOTI5NDk0ODRjZmNiN2YwMGFmMjgifQ==
- Loading branch information
1 parent
d1a4b77
commit f4b2dda
Showing
424 changed files
with
205,175 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
281 changes: 281 additions & 0 deletions
281
...ngine/src/main/java/com/google/cloud/discoveryengine/v1alpha/CompletionServiceClient.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,281 @@ | ||
| /* | ||
| * Copyright 2023 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.v1alpha; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.gax.core.BackgroundResource; | ||
| import com.google.api.gax.rpc.UnaryCallable; | ||
| import com.google.cloud.discoveryengine.v1alpha.stub.CompletionServiceStub; | ||
| import com.google.cloud.discoveryengine.v1alpha.stub.CompletionServiceStubSettings; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import javax.annotation.Generated; | ||
|
|
||
| // AUTO-GENERATED DOCUMENTATION AND CLASS. | ||
| /** | ||
| * Service Description: Service for Auto-Completion. | ||
| * | ||
| * <p>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: | ||
| * | ||
| * <pre>{@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 (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) { | ||
| * CompleteQueryRequest request = | ||
| * CompleteQueryRequest.newBuilder() | ||
| * .setDataStore( | ||
| * DataStoreName.ofProjectLocationDataStoreName( | ||
| * "[PROJECT]", "[LOCATION]", "[DATA_STORE]") | ||
| * .toString()) | ||
| * .setQuery("query107944136") | ||
| * .setQueryModel("queryModel-184930495") | ||
| * .setUserPseudoId("userPseudoId-1155274652") | ||
| * .setIncludeTailSuggestions(true) | ||
| * .build(); | ||
| * CompleteQueryResponse response = completionServiceClient.completeQuery(request); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * <p>Note: close() needs to be called on the CompletionServiceClient object to clean up resources | ||
| * such as threads. In the example above, try-with-resources is used, which automatically calls | ||
| * close(). | ||
| * | ||
| * <p>The surface of this class includes several types of Java methods for each of the API's | ||
| * methods: | ||
| * | ||
| * <ol> | ||
| * <li>A "flattened" method. With this type of method, the fields of the request type have been | ||
| * converted into function parameters. It may be the case that not all fields are available as | ||
| * parameters, and not every API method will have a flattened method entry point. | ||
| * <li>A "request object" method. This type of method only takes one parameter, a request object, | ||
| * which must be constructed before the call. Not every API method will have a request object | ||
| * method. | ||
| * <li>A "callable" method. This type of method takes no parameters and returns an immutable API | ||
| * callable object, which can be used to initiate calls to the service. | ||
| * </ol> | ||
| * | ||
| * <p>See the individual methods for example code. | ||
| * | ||
| * <p>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. | ||
| * | ||
| * <p>This class can be customized by passing in a custom instance of CompletionServiceSettings to | ||
| * create(). For example: | ||
| * | ||
| * <p>To customize credentials: | ||
| * | ||
| * <pre>{@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 | ||
| * CompletionServiceSettings completionServiceSettings = | ||
| * CompletionServiceSettings.newBuilder() | ||
| * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) | ||
| * .build(); | ||
| * CompletionServiceClient completionServiceClient = | ||
| * CompletionServiceClient.create(completionServiceSettings); | ||
| * }</pre> | ||
| * | ||
| * <p>To customize the endpoint: | ||
| * | ||
| * <pre>{@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 | ||
| * CompletionServiceSettings completionServiceSettings = | ||
| * CompletionServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); | ||
| * CompletionServiceClient completionServiceClient = | ||
| * CompletionServiceClient.create(completionServiceSettings); | ||
| * }</pre> | ||
| * | ||
| * <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over | ||
| * the wire: | ||
| * | ||
| * <pre>{@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 | ||
| * CompletionServiceSettings completionServiceSettings = | ||
| * CompletionServiceSettings.newHttpJsonBuilder().build(); | ||
| * CompletionServiceClient completionServiceClient = | ||
| * CompletionServiceClient.create(completionServiceSettings); | ||
| * }</pre> | ||
| * | ||
| * <p>Please refer to the GitHub repository's samples for more quickstart code snippets. | ||
| */ | ||
| @BetaApi | ||
| @Generated("by gapic-generator-java") | ||
| public class CompletionServiceClient implements BackgroundResource { | ||
| private final CompletionServiceSettings settings; | ||
| private final CompletionServiceStub stub; | ||
|
|
||
| /** Constructs an instance of CompletionServiceClient with default settings. */ | ||
| public static final CompletionServiceClient create() throws IOException { | ||
| return create(CompletionServiceSettings.newBuilder().build()); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs an instance of CompletionServiceClient, 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 CompletionServiceClient create(CompletionServiceSettings settings) | ||
| throws IOException { | ||
| return new CompletionServiceClient(settings); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs an instance of CompletionServiceClient, using the given stub for making calls. This | ||
| * is for advanced usage - prefer using create(CompletionServiceSettings). | ||
| */ | ||
| public static final CompletionServiceClient create(CompletionServiceStub stub) { | ||
| return new CompletionServiceClient(stub); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs an instance of CompletionServiceClient, 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 CompletionServiceClient(CompletionServiceSettings settings) throws IOException { | ||
| this.settings = settings; | ||
| this.stub = ((CompletionServiceStubSettings) settings.getStubSettings()).createStub(); | ||
| } | ||
|
|
||
| protected CompletionServiceClient(CompletionServiceStub stub) { | ||
| this.settings = null; | ||
| this.stub = stub; | ||
| } | ||
|
|
||
| public final CompletionServiceSettings getSettings() { | ||
| return settings; | ||
| } | ||
|
|
||
| public CompletionServiceStub getStub() { | ||
| return stub; | ||
| } | ||
|
|
||
| // AUTO-GENERATED DOCUMENTATION AND METHOD. | ||
| /** | ||
| * Completes the specified user input with keyword suggestions. | ||
| * | ||
| * <p>Sample code: | ||
| * | ||
| * <pre>{@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 (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) { | ||
| * CompleteQueryRequest request = | ||
| * CompleteQueryRequest.newBuilder() | ||
| * .setDataStore( | ||
| * DataStoreName.ofProjectLocationDataStoreName( | ||
| * "[PROJECT]", "[LOCATION]", "[DATA_STORE]") | ||
| * .toString()) | ||
| * .setQuery("query107944136") | ||
| * .setQueryModel("queryModel-184930495") | ||
| * .setUserPseudoId("userPseudoId-1155274652") | ||
| * .setIncludeTailSuggestions(true) | ||
| * .build(); | ||
| * CompleteQueryResponse response = completionServiceClient.completeQuery(request); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @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 CompleteQueryResponse completeQuery(CompleteQueryRequest request) { | ||
| return completeQueryCallable().call(request); | ||
| } | ||
|
|
||
| // AUTO-GENERATED DOCUMENTATION AND METHOD. | ||
| /** | ||
| * Completes the specified user input with keyword suggestions. | ||
| * | ||
| * <p>Sample code: | ||
| * | ||
| * <pre>{@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 (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) { | ||
| * CompleteQueryRequest request = | ||
| * CompleteQueryRequest.newBuilder() | ||
| * .setDataStore( | ||
| * DataStoreName.ofProjectLocationDataStoreName( | ||
| * "[PROJECT]", "[LOCATION]", "[DATA_STORE]") | ||
| * .toString()) | ||
| * .setQuery("query107944136") | ||
| * .setQueryModel("queryModel-184930495") | ||
| * .setUserPseudoId("userPseudoId-1155274652") | ||
| * .setIncludeTailSuggestions(true) | ||
| * .build(); | ||
| * ApiFuture<CompleteQueryResponse> future = | ||
| * completionServiceClient.completeQueryCallable().futureCall(request); | ||
| * // Do something. | ||
| * CompleteQueryResponse response = future.get(); | ||
| * } | ||
| * }</pre> | ||
| */ | ||
| public final UnaryCallable<CompleteQueryRequest, CompleteQueryResponse> completeQueryCallable() { | ||
| return stub.completeQueryCallable(); | ||
| } | ||
|
|
||
| @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); | ||
| } | ||
| } |
Oops, something went wrong.