KnowledgeBasesClient (Google Cloud Dialog Flow API Parent 4.9.1 API)

java.lang.Object
- com.google.cloud.dialogflow.v2.KnowledgeBasesClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

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

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:


 // 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:

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.
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.
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

All Methods Static Methods Instance Methods Concrete Methods
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, 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()
```