com.google.cloud.dialogflow.v2beta1

Class KnowledgeBasesClient

java.lang.Object

com.google.cloud.dialogflow.v2beta1.KnowledgeBasesClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class KnowledgeBasesClient
extends Object
implements BackgroundResource

Service Description: Service for managing [KnowledgeBases][google.cloud.dialogflow.v2beta1.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:

 // 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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. 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.
2. 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.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of KnowledgeBasesSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 KnowledgeBasesSettings knowledgeBasesSettings =
     KnowledgeBasesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:

 // 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()
         .setTransportChannelProvider(
             KnowledgeBasesSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KnowledgeBasesClient.ListKnowledgeBasesFixedSizeCollection
static class	KnowledgeBasesClient.ListKnowledgeBasesPage
static class	KnowledgeBasesClient.ListKnowledgeBasesPagedResponse
static class	KnowledgeBasesClient.ListLocationsFixedSizeCollection
static class	KnowledgeBasesClient.ListLocationsPage
static class	KnowledgeBasesClient.ListLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KnowledgeBasesClient(KnowledgeBasesSettings settings) Constructs an instance of KnowledgeBasesClient, using the given settings.
protected	KnowledgeBasesClient(KnowledgeBasesStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static KnowledgeBasesClient	create() Constructs an instance of KnowledgeBasesClient with default settings.
static KnowledgeBasesClient	create(KnowledgeBasesSettings settings) Constructs an instance of KnowledgeBasesClient, using the given settings.
static KnowledgeBasesClient	create(KnowledgeBasesStub stub) Constructs an instance of KnowledgeBasesClient, using the given stub for making calls.
KnowledgeBase	createKnowledgeBase(CreateKnowledgeBaseRequest request) Creates a knowledge base.
KnowledgeBase	createKnowledgeBase(LocationName parent, KnowledgeBase knowledgeBase) Creates a knowledge base.
KnowledgeBase	createKnowledgeBase(ProjectName parent, KnowledgeBase knowledgeBase) Creates a knowledge base.
KnowledgeBase	createKnowledgeBase(String parent, KnowledgeBase knowledgeBase) Creates a knowledge base.
UnaryCallable<CreateKnowledgeBaseRequest,KnowledgeBase>	createKnowledgeBaseCallable() Creates a knowledge base.
void	deleteKnowledgeBase(DeleteKnowledgeBaseRequest request) Deletes the specified knowledge base.
void	deleteKnowledgeBase(KnowledgeBaseName name) Deletes the specified knowledge base.
void	deleteKnowledgeBase(String name) Deletes the specified knowledge base.
UnaryCallable<DeleteKnowledgeBaseRequest,Empty>	deleteKnowledgeBaseCallable() Deletes the specified knowledge base.
KnowledgeBase	getKnowledgeBase(GetKnowledgeBaseRequest request) Retrieves the specified knowledge base.
KnowledgeBase	getKnowledgeBase(KnowledgeBaseName name) Retrieves the specified knowledge base.
KnowledgeBase	getKnowledgeBase(String name) Retrieves the specified knowledge base.
UnaryCallable<GetKnowledgeBaseRequest,KnowledgeBase>	getKnowledgeBaseCallable() Retrieves the specified knowledge base.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
KnowledgeBasesSettings	getSettings()
KnowledgeBasesStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse	listKnowledgeBases(ListKnowledgeBasesRequest request) Returns the list of all knowledge bases of the specified agent.
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse	listKnowledgeBases(LocationName parent) Returns the list of all knowledge bases of the specified agent.
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse	listKnowledgeBases(ProjectName parent) Returns the list of all knowledge bases of the specified agent.
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse	listKnowledgeBases(String parent) Returns the list of all knowledge bases of the specified agent.
UnaryCallable<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse>	listKnowledgeBasesCallable() Returns the list of all knowledge bases of the specified agent.
UnaryCallable<ListKnowledgeBasesRequest,KnowledgeBasesClient.ListKnowledgeBasesPagedResponse>	listKnowledgeBasesPagedCallable() Returns the list of all knowledge bases of the specified agent.
KnowledgeBasesClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
UnaryCallable<com.google.cloud.location.ListLocationsRequest,KnowledgeBasesClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
void	shutdown()
void	shutdownNow()
KnowledgeBase	updateKnowledgeBase(KnowledgeBase knowledgeBase) Updates the specified knowledge base.
KnowledgeBase	updateKnowledgeBase(KnowledgeBase knowledgeBase, FieldMask updateMask) Updates the specified knowledge base.
KnowledgeBase	updateKnowledgeBase(UpdateKnowledgeBaseRequest request) Updates the specified knowledge base.
UnaryCallable<UpdateKnowledgeBaseRequest,KnowledgeBase>	updateKnowledgeBaseCallable() Updates the specified knowledge base.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KnowledgeBasesClient

protected KnowledgeBasesClient(KnowledgeBasesSettings settings)
                        throws IOException

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.

Throws:

IOException

KnowledgeBasesClient

protected KnowledgeBasesClient(KnowledgeBasesStub stub)

Method Detail

create

public static final KnowledgeBasesClient create()
                                         throws IOException

Constructs an instance of KnowledgeBasesClient with default settings.

Throws:

IOException

create

public static final KnowledgeBasesClient create(KnowledgeBasesSettings settings)
                                         throws IOException

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.

Throws:

IOException

create

public static final KnowledgeBasesClient create(KnowledgeBasesStub stub)

Constructs an instance of KnowledgeBasesClient, using the given stub for making calls. This is for advanced usage - prefer using create(KnowledgeBasesSettings).

getSettings

public final KnowledgeBasesSettings getSettings()

getStub

public KnowledgeBasesStub getStub()

listKnowledgeBases

public final KnowledgeBasesClient.ListKnowledgeBasesPagedResponse listKnowledgeBases(LocationName parent)

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The project to list of knowledge bases for. Format: `projects/<Project ID>/locations/<Location ID>`.

Throws:

ApiException - if the remote call fails

listKnowledgeBases

public final KnowledgeBasesClient.ListKnowledgeBasesPagedResponse listKnowledgeBases(ProjectName parent)

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The project to list of knowledge bases for. Format: `projects/<Project ID>/locations/<Location ID>`.

Throws:

ApiException - if the remote call fails

listKnowledgeBases

public final KnowledgeBasesClient.ListKnowledgeBasesPagedResponse listKnowledgeBases(String parent)

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (KnowledgeBase element : knowledgeBasesClient.listKnowledgeBases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The project to list of knowledge bases for. Format: `projects/<Project ID>/locations/<Location ID>`.

Throws:

ApiException - if the remote call fails

listKnowledgeBases

public final KnowledgeBasesClient.ListKnowledgeBasesPagedResponse listKnowledgeBases(ListKnowledgeBasesRequest request)

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listKnowledgeBasesPagedCallable

public final UnaryCallable<ListKnowledgeBasesRequest,KnowledgeBasesClient.ListKnowledgeBasesPagedResponse> listKnowledgeBasesPagedCallable()

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   ListKnowledgeBasesRequest request =
       ListKnowledgeBasesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<KnowledgeBase> future =
       knowledgeBasesClient.listKnowledgeBasesPagedCallable().futureCall(request);
   // Do something.
   for (KnowledgeBase element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listKnowledgeBasesCallable

public final UnaryCallable<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse> listKnowledgeBasesCallable()

Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
 

getKnowledgeBase

public final KnowledgeBase getKnowledgeBase(KnowledgeBaseName name)

Retrieves the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   KnowledgeBaseName name =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
 }
 

Parameters:

name - Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.

Throws:

ApiException - if the remote call fails

getKnowledgeBase

public final KnowledgeBase getKnowledgeBase(String name)

Retrieves the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   String name =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
 }
 

Parameters:

name - Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.

Throws:

ApiException - if the remote call fails

getKnowledgeBase

public final KnowledgeBase getKnowledgeBase(GetKnowledgeBaseRequest request)

Retrieves the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   GetKnowledgeBaseRequest request =
       GetKnowledgeBaseRequest.newBuilder()
           .setName(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .build();
   KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getKnowledgeBaseCallable

public final UnaryCallable<GetKnowledgeBaseRequest,KnowledgeBase> getKnowledgeBaseCallable()

Retrieves the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   GetKnowledgeBaseRequest request =
       GetKnowledgeBaseRequest.newBuilder()
           .setName(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .build();
   ApiFuture<KnowledgeBase> future =
       knowledgeBasesClient.getKnowledgeBaseCallable().futureCall(request);
   // Do something.
   KnowledgeBase response = future.get();
 }
 

createKnowledgeBase

public final KnowledgeBase createKnowledgeBase(LocationName parent,
                                               KnowledgeBase knowledgeBase)

Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
   KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
 }
 

Parameters:

parent - Required. The project to create a knowledge base for. Format: `projects/<Project ID>/locations/<Location ID>`.

knowledgeBase - Required. The knowledge base to create.

Throws:

ApiException - if the remote call fails

createKnowledgeBase

public final KnowledgeBase createKnowledgeBase(ProjectName parent,
                                               KnowledgeBase knowledgeBase)

Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
   KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
 }
 

Parameters:

parent - Required. The project to create a knowledge base for. Format: `projects/<Project ID>/locations/<Location ID>`.

knowledgeBase - Required. The knowledge base to create.

Throws:

ApiException - if the remote call fails

createKnowledgeBase

public final KnowledgeBase createKnowledgeBase(String parent,
                                               KnowledgeBase knowledgeBase)

Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
   KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(parent, knowledgeBase);
 }
 

Parameters:

parent - Required. The project to create a knowledge base for. Format: `projects/<Project ID>/locations/<Location ID>`.

knowledgeBase - Required. The knowledge base to create.

Throws:

ApiException - if the remote call fails

createKnowledgeBase

public final KnowledgeBase createKnowledgeBase(CreateKnowledgeBaseRequest request)

Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   CreateKnowledgeBaseRequest request =
       CreateKnowledgeBaseRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setKnowledgeBase(KnowledgeBase.newBuilder().build())
           .build();
   KnowledgeBase response = knowledgeBasesClient.createKnowledgeBase(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

createKnowledgeBaseCallable

public final UnaryCallable<CreateKnowledgeBaseRequest,KnowledgeBase> createKnowledgeBaseCallable()

Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   CreateKnowledgeBaseRequest request =
       CreateKnowledgeBaseRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setKnowledgeBase(KnowledgeBase.newBuilder().build())
           .build();
   ApiFuture<KnowledgeBase> future =
       knowledgeBasesClient.createKnowledgeBaseCallable().futureCall(request);
   // Do something.
   KnowledgeBase response = future.get();
 }
 

deleteKnowledgeBase

public final void deleteKnowledgeBase(KnowledgeBaseName name)

Deletes the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   KnowledgeBaseName name =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   knowledgeBasesClient.deleteKnowledgeBase(name);
 }
 

Parameters:

name - Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.

Throws:

ApiException - if the remote call fails

deleteKnowledgeBase

public final void deleteKnowledgeBase(String name)

Deletes the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   String name =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   knowledgeBasesClient.deleteKnowledgeBase(name);
 }
 

Parameters:

name - Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>`.

Throws:

ApiException - if the remote call fails

deleteKnowledgeBase

public final void deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)

Deletes the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   DeleteKnowledgeBaseRequest request =
       DeleteKnowledgeBaseRequest.newBuilder()
           .setName(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setForce(true)
           .build();
   knowledgeBasesClient.deleteKnowledgeBase(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteKnowledgeBaseCallable

public final UnaryCallable<DeleteKnowledgeBaseRequest,Empty> deleteKnowledgeBaseCallable()

Deletes the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   DeleteKnowledgeBaseRequest request =
       DeleteKnowledgeBaseRequest.newBuilder()
           .setName(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future =
       knowledgeBasesClient.deleteKnowledgeBaseCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

updateKnowledgeBase

public final KnowledgeBase updateKnowledgeBase(KnowledgeBase knowledgeBase)

Updates the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
   KnowledgeBase response = knowledgeBasesClient.updateKnowledgeBase(knowledgeBase);
 }
 

Parameters:

knowledgeBase - Required. The knowledge base to update.

Throws:

ApiException - if the remote call fails

updateKnowledgeBase

public final KnowledgeBase updateKnowledgeBase(KnowledgeBase knowledgeBase,
                                               FieldMask updateMask)

Updates the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   KnowledgeBase knowledgeBase = KnowledgeBase.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   KnowledgeBase response = knowledgeBasesClient.updateKnowledgeBase(knowledgeBase, updateMask);
 }
 

Parameters:

knowledgeBase - Required. The knowledge base to update.

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:

ApiException - if the remote call fails

updateKnowledgeBase

public final KnowledgeBase updateKnowledgeBase(UpdateKnowledgeBaseRequest request)

Updates the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   UpdateKnowledgeBaseRequest request =
       UpdateKnowledgeBaseRequest.newBuilder()
           .setKnowledgeBase(KnowledgeBase.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   KnowledgeBase response = knowledgeBasesClient.updateKnowledgeBase(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateKnowledgeBaseCallable

public final UnaryCallable<UpdateKnowledgeBaseRequest,KnowledgeBase> updateKnowledgeBaseCallable()

Updates the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   UpdateKnowledgeBaseRequest request =
       UpdateKnowledgeBaseRequest.newBuilder()
           .setKnowledgeBase(KnowledgeBase.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<KnowledgeBase> future =
       knowledgeBasesClient.updateKnowledgeBaseCallable().futureCall(request);
   // Do something.
   KnowledgeBase response = future.get();
 }
 

listLocations

public final KnowledgeBasesClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listLocationsPagedCallable

public final UnaryCallable<com.google.cloud.location.ListLocationsRequest,KnowledgeBasesClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       knowledgeBasesClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)

Gets information about a location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = knowledgeBasesClient.getLocation(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getLocationCallable

public final UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()

Gets information about a location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = knowledgeBasesClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException