com.google.cloud.dialogflow.v2.AgentsClient Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow Show documentation
/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.v2;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.v2.stub.AgentsStub;
import com.google.cloud.dialogflow.v2.stub.AgentsStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import com.google.protobuf.Struct;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing [Agents][google.cloud.dialogflow.v2.Agent].
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Agent response = agentsClient.getAgent(parent);
* }
* }
*
* Note: close() needs to be called on the AgentsClient 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 AgentsSettings to create().
* For example:
*
*
To customize credentials:
*
*
{@code
* AgentsSettings agentsSettings =
* AgentsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AgentsClient agentsClient = AgentsClient.create(agentsSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(myEndpoint).build();
* AgentsClient agentsClient = AgentsClient.create(agentsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AgentsClient implements BackgroundResource {
private final AgentsSettings settings;
private final AgentsStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of AgentsClient with default settings. */
public static final AgentsClient create() throws IOException {
return create(AgentsSettings.newBuilder().build());
}
/**
* Constructs an instance of AgentsClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final AgentsClient create(AgentsSettings settings) throws IOException {
return new AgentsClient(settings);
}
/**
* Constructs an instance of AgentsClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(AgentsSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final AgentsClient create(AgentsStub stub) {
return new AgentsClient(stub);
}
/**
* Constructs an instance of AgentsClient, using the given settings. This is protected so that it
* is easy to make a subclass, but otherwise, the static factory methods should be preferred.
*/
protected AgentsClient(AgentsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AgentsStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected AgentsClient(AgentsStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final AgentsSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AgentsStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified agent.
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Agent response = agentsClient.getAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to fetch is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent getAgent(LocationName parent) {
GetAgentRequest request =
GetAgentRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return getAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* Agent response = agentsClient.getAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to fetch is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent getAgent(ProjectName parent) {
GetAgentRequest request =
GetAgentRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return getAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* Agent response = agentsClient.getAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to fetch is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent getAgent(String parent) {
GetAgentRequest request = GetAgentRequest.newBuilder().setParent(parent).build();
return getAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* GetAgentRequest request =
* GetAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* Agent response = agentsClient.getAgent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent getAgent(GetAgentRequest request) {
return getAgentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* GetAgentRequest request =
* GetAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* ApiFuture future = agentsClient.getAgentCallable().futureCall(request);
* // Do something.
* Agent response = future.get();
* }
* }
*/
public final UnaryCallable getAgentCallable() {
return stub.getAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates/updates the specified agent.
*
* Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* Agent agent = Agent.newBuilder().build();
* Agent response = agentsClient.setAgent(agent);
* }
* }
*
* @param agent Required. The agent to update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent setAgent(Agent agent) {
SetAgentRequest request = SetAgentRequest.newBuilder().setAgent(agent).build();
return setAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates/updates the specified agent.
*
* Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* SetAgentRequest request =
* SetAgentRequest.newBuilder()
* .setAgent(Agent.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Agent response = agentsClient.setAgent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Agent setAgent(SetAgentRequest request) {
return setAgentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates/updates the specified agent.
*
* Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* SetAgentRequest request =
* SetAgentRequest.newBuilder()
* .setAgent(Agent.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = agentsClient.setAgentCallable().futureCall(request);
* // Do something.
* Agent response = future.get();
* }
* }
*/
public final UnaryCallable setAgentCallable() {
return stub.setAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* agentsClient.deleteAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to delete is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgent(LocationName parent) {
DeleteAgentRequest request =
DeleteAgentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
deleteAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* agentsClient.deleteAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to delete is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgent(ProjectName parent) {
DeleteAgentRequest request =
DeleteAgentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
deleteAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* agentsClient.deleteAgent(parent);
* }
* }
*
* @param parent Required. The project that the agent to delete is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgent(String parent) {
DeleteAgentRequest request = DeleteAgentRequest.newBuilder().setParent(parent).build();
deleteAgent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* DeleteAgentRequest request =
* DeleteAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* agentsClient.deleteAgent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgent(DeleteAgentRequest request) {
deleteAgentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified agent.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* DeleteAgentRequest request =
* DeleteAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* ApiFuture future = agentsClient.deleteAgentCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteAgentCallable() {
return stub.deleteAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list agents from. Format: `projects/<Project ID or
* '-'>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchAgentsPagedResponse searchAgents(LocationName parent) {
SearchAgentsRequest request =
SearchAgentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return searchAgents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list agents from. Format: `projects/<Project ID or
* '-'>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchAgentsPagedResponse searchAgents(ProjectName parent) {
SearchAgentsRequest request =
SearchAgentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return searchAgents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project to list agents from. Format: `projects/<Project ID or
* '-'>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchAgentsPagedResponse searchAgents(String parent) {
SearchAgentsRequest request = SearchAgentsRequest.newBuilder().setParent(parent).build();
return searchAgents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* SearchAgentsRequest request =
* SearchAgentsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Agent element : agentsClient.searchAgents(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchAgentsPagedResponse searchAgents(SearchAgentsRequest request) {
return searchAgentsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* SearchAgentsRequest request =
* SearchAgentsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future = agentsClient.searchAgentsPagedCallable().futureCall(request);
* // Do something.
* for (Agent element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
searchAgentsPagedCallable() {
return stub.searchAgentsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of agents.
*
* Since there is at most one conversational agent per project, this method is useful primarily
* for listing all agents across projects the caller has access to. One can achieve that with a
* wildcard project collection id "-". Refer to [List
* Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* SearchAgentsRequest request =
* SearchAgentsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* SearchAgentsResponse response = agentsClient.searchAgentsCallable().call(request);
* for (Agent element : response.getResponsesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable searchAgentsCallable() {
return stub.searchAgentsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* agentsClient.trainAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to train is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainAgentAsync(LocationName parent) {
TrainAgentRequest request =
TrainAgentRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return trainAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* agentsClient.trainAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to train is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainAgentAsync(ProjectName parent) {
TrainAgentRequest request =
TrainAgentRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return trainAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* agentsClient.trainAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to train is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainAgentAsync(String parent) {
TrainAgentRequest request = TrainAgentRequest.newBuilder().setParent(parent).build();
return trainAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* TrainAgentRequest request =
* TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* agentsClient.trainAgentAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainAgentAsync(TrainAgentRequest request) {
return trainAgentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* TrainAgentRequest request =
* TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* OperationFuture future =
* agentsClient.trainAgentOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable trainAgentOperationCallable() {
return stub.trainAgentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified agent.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* TrainAgentRequest request =
* TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* ApiFuture future = agentsClient.trainAgentCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable trainAgentCallable() {
return stub.trainAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to export is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture exportAgentAsync(LocationName parent) {
ExportAgentRequest request =
ExportAgentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return exportAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to export is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture exportAgentAsync(ProjectName parent) {
ExportAgentRequest request =
ExportAgentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return exportAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
* }
* }
*
* @param parent Required. The project that the agent to export is associated with. Format:
* `projects/<Project ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture exportAgentAsync(String parent) {
ExportAgentRequest request = ExportAgentRequest.newBuilder().setParent(parent).build();
return exportAgentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ExportAgentRequest request =
* ExportAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setAgentUri("agentUri1469149223")
* .build();
* ExportAgentResponse response = agentsClient.exportAgentAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture exportAgentAsync(
ExportAgentRequest request) {
return exportAgentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ExportAgentRequest request =
* ExportAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setAgentUri("agentUri1469149223")
* .build();
* OperationFuture future =
* agentsClient.exportAgentOperationCallable().futureCall(request);
* // Do something.
* ExportAgentResponse response = future.get();
* }
* }
*/
public final OperationCallable
exportAgentOperationCallable() {
return stub.exportAgentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a ZIP file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ExportAgentRequest request =
* ExportAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setAgentUri("agentUri1469149223")
* .build();
* ApiFuture future = agentsClient.exportAgentCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable exportAgentCallable() {
return stub.exportAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified agent from a ZIP file.
*
* Uploads new intents and entity types without deleting the existing ones. Intents and entity
* types with the same name are replaced with the new versions from
* [ImportAgentRequest][google.cloud.dialogflow.v2.ImportAgentRequest]. After the import, the
* imported draft agent will be trained automatically (unless disabled in agent settings).
* However, once the import is done, training may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when importing is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ImportAgentRequest request =
* ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* agentsClient.importAgentAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture importAgentAsync(ImportAgentRequest request) {
return importAgentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified agent from a ZIP file.
*
* Uploads new intents and entity types without deleting the existing ones. Intents and entity
* types with the same name are replaced with the new versions from
* [ImportAgentRequest][google.cloud.dialogflow.v2.ImportAgentRequest]. After the import, the
* imported draft agent will be trained automatically (unless disabled in agent settings).
* However, once the import is done, training may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when importing is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ImportAgentRequest request =
* ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* OperationFuture future =
* agentsClient.importAgentOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable importAgentOperationCallable() {
return stub.importAgentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified agent from a ZIP file.
*
* Uploads new intents and entity types without deleting the existing ones. Intents and entity
* types with the same name are replaced with the new versions from
* [ImportAgentRequest][google.cloud.dialogflow.v2.ImportAgentRequest]. After the import, the
* imported draft agent will be trained automatically (unless disabled in agent settings).
* However, once the import is done, training may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when importing is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* ImportAgentRequest request =
* ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
* ApiFuture future = agentsClient.importAgentCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable importAgentCallable() {
return stub.importAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Restores the specified agent from a ZIP file.
*
* Replaces the current agent version with a new one. All the intents and entity types in the
* older version are deleted. After the restore, the restored draft agent will be trained
* automatically (unless disabled in agent settings). However, once the restore is done, training
* may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when restoring is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* RestoreAgentRequest request =
* RestoreAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .build();
* agentsClient.restoreAgentAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture restoreAgentAsync(RestoreAgentRequest request) {
return restoreAgentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Restores the specified agent from a ZIP file.
*
* Replaces the current agent version with a new one. All the intents and entity types in the
* older version are deleted. After the restore, the restored draft agent will be trained
* automatically (unless disabled in agent settings). However, once the restore is done, training
* may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when restoring is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* RestoreAgentRequest request =
* RestoreAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .build();
* OperationFuture future =
* agentsClient.restoreAgentOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable
restoreAgentOperationCallable() {
return stub.restoreAgentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Restores the specified agent from a ZIP file.
*
* Replaces the current agent version with a new one. All the intents and entity types in the
* older version are deleted. After the restore, the restored draft agent will be trained
* automatically (unless disabled in agent settings). However, once the restore is done, training
* may not be completed yet. Please call
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
* returns in order to train explicitly.
*
*
This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
The operation only tracks when restoring is complete, not when it is done training.
*
*
Note: You should always train an agent prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
*
*
Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* RestoreAgentRequest request =
* RestoreAgentRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .build();
* ApiFuture future = agentsClient.restoreAgentCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable restoreAgentCallable() {
return stub.restoreAgentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets agent validation result. Agent validation is performed during training time and is updated
* automatically when training is completed.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* GetValidationResultRequest request =
* GetValidationResultRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ValidationResult response = agentsClient.getValidationResult(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ValidationResult getValidationResult(GetValidationResultRequest request) {
return getValidationResultCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets agent validation result. Agent validation is performed during training time and is updated
* automatically when training is completed.
*
* Sample code:
*
*
{@code
* try (AgentsClient agentsClient = AgentsClient.create()) {
* GetValidationResultRequest request =
* GetValidationResultRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* agentsClient.getValidationResultCallable().futureCall(request);
* // Do something.
* ValidationResult response = future.get();
* }
* }
*/
public final UnaryCallable
getValidationResultCallable() {
return stub.getValidationResultCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class SearchAgentsPagedResponse
extends AbstractPagedListResponse<
SearchAgentsRequest,
SearchAgentsResponse,
Agent,
SearchAgentsPage,
SearchAgentsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
SearchAgentsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new SearchAgentsPagedResponse(input),
MoreExecutors.directExecutor());
}
private SearchAgentsPagedResponse(SearchAgentsPage page) {
super(page, SearchAgentsFixedSizeCollection.createEmptyCollection());
}
}
public static class SearchAgentsPage
extends AbstractPage {
private SearchAgentsPage(
PageContext context,
SearchAgentsResponse response) {
super(context, response);
}
private static SearchAgentsPage createEmptyPage() {
return new SearchAgentsPage(null, null);
}
@Override
protected SearchAgentsPage createPage(
PageContext context,
SearchAgentsResponse response) {
return new SearchAgentsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class SearchAgentsFixedSizeCollection
extends AbstractFixedSizeCollection<
SearchAgentsRequest,
SearchAgentsResponse,
Agent,
SearchAgentsPage,
SearchAgentsFixedSizeCollection> {
private SearchAgentsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static SearchAgentsFixedSizeCollection createEmptyCollection() {
return new SearchAgentsFixedSizeCollection(null, 0);
}
@Override
protected SearchAgentsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new SearchAgentsFixedSizeCollection(pages, collectionSize);
}
}
}