- 4.53.0 (latest)
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
GitHub Repository | Product Reference |
Service Description: Service for managing KnowledgeBases.
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().
Method | Description | Method Variants |
---|---|---|
ListKnowledgeBases |
Returns the list of all knowledge bases of the specified agent. Note: The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetKnowledgeBase |
Retrieves the specified knowledge base. Note: The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateKnowledgeBase |
Creates a knowledge base. Note: The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteKnowledgeBase |
Deletes the specified knowledge base. Note: The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateKnowledgeBase |
Updates the specified knowledge base. Note: The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.newHttpJsonBuilder().build();
KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final KnowledgeBasesClient create()
Constructs an instance of KnowledgeBasesClient with default settings.
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(KnowledgeBasesSettings settings)
public static final KnowledgeBasesClient create(KnowledgeBasesSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
KnowledgeBasesSettings |
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(KnowledgeBasesStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
KnowledgeBasesStub |
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient |
Constructors
KnowledgeBasesClient(KnowledgeBasesSettings settings)
protected KnowledgeBasesClient(KnowledgeBasesSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
KnowledgeBasesSettings |
KnowledgeBasesClient(KnowledgeBasesStub stub)
protected KnowledgeBasesClient(KnowledgeBasesStub stub)
Parameter | |
---|---|
Name | Description |
stub |
KnowledgeBasesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createKnowledgeBase(CreateKnowledgeBaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
CreateKnowledgeBaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
createKnowledgeBase(LocationName parent, KnowledgeBase knowledgeBase)
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 | |
---|---|
Name | Description |
parent |
LocationName Required. The project to create a knowledge base for. Format:
|
knowledgeBase |
KnowledgeBase Required. The knowledge base to create. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
createKnowledgeBase(ProjectName parent, KnowledgeBase knowledgeBase)
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 | |
---|---|
Name | Description |
parent |
ProjectName Required. The project to create a knowledge base for. Format:
|
knowledgeBase |
KnowledgeBase Required. The knowledge base to create. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
createKnowledgeBase(String parent, KnowledgeBase knowledgeBase)
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 | |
---|---|
Name | Description |
parent |
String Required. The project to create a knowledge base for. Format:
|
knowledgeBase |
KnowledgeBase Required. The knowledge base to create. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateKnowledgeBaseRequest,KnowledgeBase> |
deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteKnowledgeBaseRequest The request object containing all of the parameters for the API call. |
deleteKnowledgeBase(KnowledgeBaseName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
KnowledgeBaseName Required. The name of the knowledge base to delete. Format: |
deleteKnowledgeBase(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the knowledge base to delete. Format: |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteKnowledgeBaseRequest,Empty> |
getKnowledgeBase(GetKnowledgeBaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetKnowledgeBaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
getKnowledgeBase(KnowledgeBaseName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
KnowledgeBaseName Required. The name of the knowledge base to retrieve. Format |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
getKnowledgeBase(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the knowledge base to retrieve. Format |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetKnowledgeBaseRequest,KnowledgeBase> |
getLocation(GetLocationRequest request)
public final Location getLocation(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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final KnowledgeBasesSettings getSettings()
Returns | |
---|---|
Type | Description |
KnowledgeBasesSettings |
getStub()
public KnowledgeBasesStub getStub()
Returns | |
---|---|
Type | Description |
KnowledgeBasesStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listKnowledgeBases(ListKnowledgeBasesRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListKnowledgeBasesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse |
listKnowledgeBases(LocationName parent)
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The project to list of knowledge bases for. Format:
|
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse |
listKnowledgeBases(ProjectName parent)
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
ProjectName Required. The project to list of knowledge bases for. Format:
|
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse |
listKnowledgeBases(String parent)
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The project to list of knowledge bases for. Format:
|
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListKnowledgeBasesRequest,ListKnowledgeBasesPagedResponse> |
listLocations(ListLocationsRequest request)
public final KnowledgeBasesClient.ListLocationsPagedResponse listLocations(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);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateKnowledgeBase(KnowledgeBase knowledgeBase)
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);
}
Parameter | |
---|---|
Name | Description |
knowledgeBase |
KnowledgeBase Required. The knowledge base to update. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
updateKnowledgeBase(KnowledgeBase knowledgeBase, FieldMask updateMask)
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 | |
---|---|
Name | Description |
knowledgeBase |
KnowledgeBase Required. The knowledge base to update. |
updateMask |
FieldMask Optional. Not specified means |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateKnowledgeBaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
KnowledgeBase |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateKnowledgeBaseRequest,KnowledgeBase> |