com.google.cloud.dialogflow.v2.KnowledgeBasesClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow Show documentation
Show all versions of google-cloud-dialogflow Show documentation
Java idiomatic client for Google Cloud Dialog Flow API
/*
* 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.dialogflow.v2;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
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.dialogflow.v2.stub.KnowledgeBasesStub;
import com.google.cloud.dialogflow.v2.stub.KnowledgeBasesStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
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 managing
* [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* KnowledgeBaseName name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
* KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
* }
* }
*
* Note: close() needs to be called on the KnowledgeBasesClient 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
*
*
* ListKnowledgeBases
Returns the list of all knowledge bases of the specified agent.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listKnowledgeBases(ListKnowledgeBasesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listKnowledgeBases(LocationName parent)
*
listKnowledgeBases(ProjectName parent)
*
listKnowledgeBases(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.
*
* listKnowledgeBasesPagedCallable()
*
listKnowledgeBasesCallable()
*
*
*
*
* GetKnowledgeBase
Retrieves the specified knowledge base.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getKnowledgeBase(GetKnowledgeBaseRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getKnowledgeBase(KnowledgeBaseName name)
*
getKnowledgeBase(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.
*
* getKnowledgeBaseCallable()
*
*
*
*
* CreateKnowledgeBase
Creates a knowledge base.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createKnowledgeBase(CreateKnowledgeBaseRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createKnowledgeBase(LocationName parent, KnowledgeBase knowledgeBase)
*
createKnowledgeBase(ProjectName parent, KnowledgeBase knowledgeBase)
*
createKnowledgeBase(String parent, KnowledgeBase knowledgeBase)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createKnowledgeBaseCallable()
*
*
*
*
* DeleteKnowledgeBase
Deletes the specified knowledge base.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteKnowledgeBase(KnowledgeBaseName name)
*
deleteKnowledgeBase(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.
*
* deleteKnowledgeBaseCallable()
*
*
*
*
* UpdateKnowledgeBase
Updates the specified knowledge base.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateKnowledgeBase(KnowledgeBase knowledgeBase, 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.
*
* updateKnowledgeBaseCallable()
*
*
*
*
* ListLocations
Lists information about the supported locations for this service.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listLocations(ListLocationsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listLocationsPagedCallable()
*
listLocationsCallable()
*
*
*
*
* GetLocation
Gets information about a location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getLocation(GetLocationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getLocationCallable()
*
*
*
*
*
* 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 KnowledgeBasesSettings 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
* KnowledgeBasesSettings knowledgeBasesSettings =
* KnowledgeBasesSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
* }
*
* 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
* KnowledgeBasesSettings knowledgeBasesSettings =
* KnowledgeBasesSettings.newBuilder().setEndpoint(myEndpoint).build();
* KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
* }
*
* 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
* KnowledgeBasesSettings knowledgeBasesSettings =
* KnowledgeBasesSettings.newHttpJsonBuilder().build();
* KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class KnowledgeBasesClient implements BackgroundResource {
private final KnowledgeBasesSettings settings;
private final KnowledgeBasesStub stub;
/** Constructs an instance of KnowledgeBasesClient with default settings. */
public static final KnowledgeBasesClient create() throws IOException {
return create(KnowledgeBasesSettings.newBuilder().build());
}
/**
* Constructs an instance of KnowledgeBasesClient, 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 KnowledgeBasesClient create(KnowledgeBasesSettings settings)
throws IOException {
return new KnowledgeBasesClient(settings);
}
/**
* Constructs an instance of KnowledgeBasesClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(KnowledgeBasesSettings).
*/
public static final KnowledgeBasesClient create(KnowledgeBasesStub stub) {
return new KnowledgeBasesClient(stub);
}
/**
* Constructs an instance of KnowledgeBasesClient, 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 KnowledgeBasesClient(KnowledgeBasesSettings settings) throws IOException {
this.settings = settings;
this.stub = ((KnowledgeBasesStubSettings) settings.getStubSettings()).createStub();
}
protected KnowledgeBasesClient(KnowledgeBasesStub stub) {
this.settings = null;
this.stub = stub;
}
public final KnowledgeBasesSettings getSettings() {
return settings;
}
public KnowledgeBasesStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
*
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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list of knowledge bases for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListKnowledgeBasesPagedResponse listKnowledgeBases(LocationName parent) {
ListKnowledgeBasesRequest request =
ListKnowledgeBasesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listKnowledgeBases(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list of knowledge bases for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListKnowledgeBasesPagedResponse listKnowledgeBases(ProjectName parent) {
ListKnowledgeBasesRequest request =
ListKnowledgeBasesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listKnowledgeBases(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list of knowledge bases for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListKnowledgeBasesPagedResponse listKnowledgeBases(String parent) {
ListKnowledgeBasesRequest request =
ListKnowledgeBasesRequest.newBuilder().setParent(parent).build();
return listKnowledgeBases(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListKnowledgeBasesRequest request =
* ListKnowledgeBasesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(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 ListKnowledgeBasesPagedResponse listKnowledgeBases(
ListKnowledgeBasesRequest request) {
return listKnowledgeBasesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListKnowledgeBasesRequest request =
* ListKnowledgeBasesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* ApiFuture future =
* knowledgeBasesClient.listKnowledgeBasesPagedCallable().futureCall(request);
* // Do something.
* for (KnowledgeBase element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listKnowledgeBasesPagedCallable() {
return stub.listKnowledgeBasesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all knowledge bases of the specified agent.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListKnowledgeBasesRequest request =
* ListKnowledgeBasesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* while (true) {
* ListKnowledgeBasesResponse response =
* knowledgeBasesClient.listKnowledgeBasesCallable().call(request);
* for (KnowledgeBase element : response.getKnowledgeBasesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listKnowledgeBasesCallable() {
return stub.listKnowledgeBasesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* KnowledgeBaseName name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
* KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
* }
* }
*
* @param name Required. The name of the knowledge base to retrieve. Format `projects/<Project
* ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase getKnowledgeBase(KnowledgeBaseName name) {
GetKnowledgeBaseRequest request =
GetKnowledgeBaseRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* String name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
* KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
* }
* }
*
* @param name Required. The name of the knowledge base to retrieve. Format `projects/<Project
* ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase getKnowledgeBase(String name) {
GetKnowledgeBaseRequest request = GetKnowledgeBaseRequest.newBuilder().setName(name).build();
return getKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* GetKnowledgeBaseRequest request =
* GetKnowledgeBaseRequest.newBuilder()
* .setName(
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
* .toString())
* .build();
* KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(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 KnowledgeBase getKnowledgeBase(GetKnowledgeBaseRequest request) {
return getKnowledgeBaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* GetKnowledgeBaseRequest request =
* GetKnowledgeBaseRequest.newBuilder()
* .setName(
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
* .toString())
* .build();
* ApiFuture future =
* knowledgeBasesClient.getKnowledgeBaseCallable().futureCall(request);
* // Do something.
* KnowledgeBase response = future.get();
* }
* }
*/
public final UnaryCallable getKnowledgeBaseCallable() {
return stub.getKnowledgeBaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
* KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
* }
* }
*
* @param parent Required. The project to create a knowledge base for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @param knowledgeBase Required. The knowledge base to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase createKnowledgeBase(LocationName parent, KnowledgeBase knowledgeBase) {
CreateKnowledgeBaseRequest request =
CreateKnowledgeBaseRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setKnowledgeBase(knowledgeBase)
.build();
return createKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
* KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
* }
* }
*
* @param parent Required. The project to create a knowledge base for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @param knowledgeBase Required. The knowledge base to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase createKnowledgeBase(ProjectName parent, KnowledgeBase knowledgeBase) {
CreateKnowledgeBaseRequest request =
CreateKnowledgeBaseRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setKnowledgeBase(knowledgeBase)
.build();
return createKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
* KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
* }
* }
*
* @param parent Required. The project to create a knowledge base for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @param knowledgeBase Required. The knowledge base to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase createKnowledgeBase(String parent, KnowledgeBase knowledgeBase) {
CreateKnowledgeBaseRequest request =
CreateKnowledgeBaseRequest.newBuilder()
.setParent(parent)
.setKnowledgeBase(knowledgeBase)
.build();
return createKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* CreateKnowledgeBaseRequest request =
* CreateKnowledgeBaseRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setKnowledgeBase(KnowledgeBase.newBuilder().build())
* .build();
* KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(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 KnowledgeBase createKnowledgeBase(CreateKnowledgeBaseRequest request) {
return createKnowledgeBaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* CreateKnowledgeBaseRequest request =
* CreateKnowledgeBaseRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setKnowledgeBase(KnowledgeBase.newBuilder().build())
* .build();
* ApiFuture future =
* knowledgeBasesClient.createKnowledgeBaseCallable().futureCall(request);
* // Do something.
* KnowledgeBase response = future.get();
* }
* }
*/
public final UnaryCallable
createKnowledgeBaseCallable() {
return stub.createKnowledgeBaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* KnowledgeBaseName name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
* knowledgeBasesClient.deleteKnowledgeBase(name);
* }
* }
*
* @param name Required. The name of the knowledge base to delete. Format: `projects/<Project
* ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteKnowledgeBase(KnowledgeBaseName name) {
DeleteKnowledgeBaseRequest request =
DeleteKnowledgeBaseRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* String name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
* knowledgeBasesClient.deleteKnowledgeBase(name);
* }
* }
*
* @param name Required. The name of the knowledge base to delete. Format: `projects/<Project
* ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteKnowledgeBase(String name) {
DeleteKnowledgeBaseRequest request =
DeleteKnowledgeBaseRequest.newBuilder().setName(name).build();
deleteKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* DeleteKnowledgeBaseRequest request =
* DeleteKnowledgeBaseRequest.newBuilder()
* .setName(
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
* .toString())
* .setForce(true)
* .build();
* knowledgeBasesClient.deleteKnowledgeBase(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 deleteKnowledgeBase(DeleteKnowledgeBaseRequest request) {
deleteKnowledgeBaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* DeleteKnowledgeBaseRequest request =
* DeleteKnowledgeBaseRequest.newBuilder()
* .setName(
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
* .toString())
* .setForce(true)
* .build();
* ApiFuture future =
* knowledgeBasesClient.deleteKnowledgeBaseCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteKnowledgeBaseCallable() {
return stub.deleteKnowledgeBaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* KnowledgeBase response = knowledgeBasesClient.updateKnowledgeBase(knowledgeBase, updateMask);
* }
* }
*
* @param knowledgeBase Required. The knowledge base to update.
* @param updateMask Optional. Not specified means `update all`. Currently, only `display_name`
* can be updated, an InvalidArgument will be returned for attempting to update other fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final KnowledgeBase updateKnowledgeBase(
KnowledgeBase knowledgeBase, FieldMask updateMask) {
UpdateKnowledgeBaseRequest request =
UpdateKnowledgeBaseRequest.newBuilder()
.setKnowledgeBase(knowledgeBase)
.setUpdateMask(updateMask)
.build();
return updateKnowledgeBase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* UpdateKnowledgeBaseRequest request =
* UpdateKnowledgeBaseRequest.newBuilder()
* .setKnowledgeBase(KnowledgeBase.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* KnowledgeBase response = knowledgeBasesClient.updateKnowledgeBase(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 KnowledgeBase updateKnowledgeBase(UpdateKnowledgeBaseRequest request) {
return updateKnowledgeBaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified knowledge base.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* UpdateKnowledgeBaseRequest request =
* UpdateKnowledgeBaseRequest.newBuilder()
* .setKnowledgeBase(KnowledgeBase.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* knowledgeBasesClient.updateKnowledgeBaseCallable().futureCall(request);
* // Do something.
* KnowledgeBase response = future.get();
* }
* }
*/
public final UnaryCallable
updateKnowledgeBaseCallable() {
return stub.updateKnowledgeBaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : knowledgeBasesClient.listLocations(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 ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* knowledgeBasesClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = knowledgeBasesClient.listLocationsCallable().call(request);
* for (Location element : response.getLocationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = knowledgeBasesClient.getLocation(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 Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* 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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = knowledgeBasesClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@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 ListKnowledgeBasesPagedResponse
extends AbstractPagedListResponse<
ListKnowledgeBasesRequest,
ListKnowledgeBasesResponse,
KnowledgeBase,
ListKnowledgeBasesPage,
ListKnowledgeBasesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListKnowledgeBasesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListKnowledgeBasesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListKnowledgeBasesPagedResponse(ListKnowledgeBasesPage page) {
super(page, ListKnowledgeBasesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListKnowledgeBasesPage
extends AbstractPage<
ListKnowledgeBasesRequest,
ListKnowledgeBasesResponse,
KnowledgeBase,
ListKnowledgeBasesPage> {
private ListKnowledgeBasesPage(
PageContext context,
ListKnowledgeBasesResponse response) {
super(context, response);
}
private static ListKnowledgeBasesPage createEmptyPage() {
return new ListKnowledgeBasesPage(null, null);
}
@Override
protected ListKnowledgeBasesPage createPage(
PageContext context,
ListKnowledgeBasesResponse response) {
return new ListKnowledgeBasesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListKnowledgeBasesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListKnowledgeBasesRequest,
ListKnowledgeBasesResponse,
KnowledgeBase,
ListKnowledgeBasesPage,
ListKnowledgeBasesFixedSizeCollection> {
private ListKnowledgeBasesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListKnowledgeBasesFixedSizeCollection createEmptyCollection() {
return new ListKnowledgeBasesFixedSizeCollection(null, 0);
}
@Override
protected ListKnowledgeBasesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListKnowledgeBasesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}