com.google.cloud.dialogflow.v2beta1

Class AgentsClient

java.lang.Object

com.google.cloud.dialogflow.v2beta1.AgentsClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

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

Service Description: Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add [Intents][google.cloud.dialogflow.v2beta1.Intents], [Contexts][google.cloud.dialogflow.v2beta1.Contexts], [Entity Types][google.cloud.dialogflow.v2beta1.EntityTypes], [Webhooks][google.cloud.dialogflow.v2beta1.WebhookRequest], and so on to manage the flow of a conversation and match user input to predefined intents and actions.

You can create an agent using both Dialogflow Standard Edition and Dialogflow Enterprise Edition. For details, see [Dialogflow Editions](https://cloud.google.com/dialogflow-enterprise/docs/editions).

You can save your agent for backup or versioning by exporting the agent by using the [ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent] method. You can import a saved agent by using the [ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent] method.

Dialogflow provides several [prebuilt agents](https://cloud.google.com/dialogflow-enterprise/docs/agents-prebuilt) for common conversation scenarios such as determining a date and time, converting currency, and so on.

For more information about agents, see the [Dialogflow documentation](https://cloud.google.com/dialogflow-enterprise/docs/agents-overview).

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:

 
 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   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:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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

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

To customize credentials:

 
 AgentsSettings agentsSettings =
     AgentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AgentsClient agentsClient =
     AgentsClient.create(agentsSettings);
 
 

To customize the endpoint:

 
 AgentsSettings agentsSettings =
     AgentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 AgentsClient agentsClient =
     AgentsClient.create(agentsSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentsClient.SearchAgentsFixedSizeCollection
static class	AgentsClient.SearchAgentsPage
static class	AgentsClient.SearchAgentsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AgentsClient(AgentsSettings settings) Constructs an instance of AgentsClient, using the given settings.
protected	AgentsClient(AgentsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AgentsClient	create() Constructs an instance of AgentsClient with default settings.
static AgentsClient	create(AgentsSettings settings) Constructs an instance of AgentsClient, using the given settings.
static AgentsClient	create(AgentsStub stub) Constructs an instance of AgentsClient, using the given stub for making calls.
OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct>	exportAgentAsync(com.google.cloud.dialogflow.v2beta1.ExportAgentRequest request) Exports the specified agent to a ZIP file.
OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct>	exportAgentAsync(com.google.cloud.dialogflow.v2beta1.ProjectName parent) Exports the specified agent to a ZIP file.
OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct>	exportAgentAsync(String parent) Exports the specified agent to a ZIP file.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.ExportAgentRequest,Operation>	exportAgentCallable() Exports the specified agent to a ZIP file.
OperationCallable<com.google.cloud.dialogflow.v2beta1.ExportAgentRequest,com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct>	exportAgentOperationCallable() Exports the specified agent to a ZIP file.
com.google.cloud.dialogflow.v2beta1.Agent	getAgent(com.google.cloud.dialogflow.v2beta1.GetAgentRequest request) Retrieves the specified agent.
com.google.cloud.dialogflow.v2beta1.Agent	getAgent(com.google.cloud.dialogflow.v2beta1.ProjectName parent) Retrieves the specified agent.
com.google.cloud.dialogflow.v2beta1.Agent	getAgent(String parent) Retrieves the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.GetAgentRequest,com.google.cloud.dialogflow.v2beta1.Agent>	getAgentCallable() Retrieves the specified agent.
OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
AgentsSettings	getSettings()
AgentsStub	getStub()
OperationFuture<Empty,Struct>	importAgentAsync(com.google.cloud.dialogflow.v2beta1.ImportAgentRequest request) Imports the specified agent from a ZIP file.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.ImportAgentRequest,Operation>	importAgentCallable() Imports the specified agent from a ZIP file.
OperationCallable<com.google.cloud.dialogflow.v2beta1.ImportAgentRequest,Empty,Struct>	importAgentOperationCallable() Imports the specified agent from a ZIP file.
boolean	isShutdown()
boolean	isTerminated()
OperationFuture<Empty,Struct>	restoreAgentAsync(com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest request) Restores the specified agent from a ZIP file.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest,Operation>	restoreAgentCallable() Restores the specified agent from a ZIP file.
OperationCallable<com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest,Empty,Struct>	restoreAgentOperationCallable() Restores the specified agent from a ZIP file.
AgentsClient.SearchAgentsPagedResponse	searchAgents(com.google.cloud.dialogflow.v2beta1.ProjectName parent) Returns the list of agents.
AgentsClient.SearchAgentsPagedResponse	searchAgents(com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest request) Returns the list of agents.
AgentsClient.SearchAgentsPagedResponse	searchAgents(String parent) Returns the list of agents.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest,com.google.cloud.dialogflow.v2beta1.SearchAgentsResponse>	searchAgentsCallable() Returns the list of agents.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest,AgentsClient.SearchAgentsPagedResponse>	searchAgentsPagedCallable() Returns the list of agents.
void	shutdown()
void	shutdownNow()
OperationFuture<Empty,Struct>	trainAgentAsync(com.google.cloud.dialogflow.v2beta1.ProjectName parent) Trains the specified agent.
OperationFuture<Empty,Struct>	trainAgentAsync(String parent) Trains the specified agent.
OperationFuture<Empty,Struct>	trainAgentAsync(com.google.cloud.dialogflow.v2beta1.TrainAgentRequest request) Trains the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2beta1.TrainAgentRequest,Operation>	trainAgentCallable() Trains the specified agent.
OperationCallable<com.google.cloud.dialogflow.v2beta1.TrainAgentRequest,Empty,Struct>	trainAgentOperationCallable() Trains the specified agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentsClient

protected AgentsClient(AgentsSettings settings)
                throws IOException

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.

Throws:

IOException

AgentsClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AgentsClient(AgentsStub stub)

Method Detail

create

public static final AgentsClient create()
                                 throws IOException

Constructs an instance of AgentsClient with default settings.

Throws:

IOException

create

public static final AgentsClient create(AgentsSettings settings)
                                 throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final AgentsClient create(AgentsStub stub)

Constructs an instance of AgentsClient, using the given stub for making calls. This is for advanced usage - prefer to use AgentsSettings}.

getSettings

public final AgentsSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public AgentsStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getAgent

public final com.google.cloud.dialogflow.v2beta1.Agent getAgent(com.google.cloud.dialogflow.v2beta1.ProjectName parent)

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Agent response = agentsClient.getAgent(parent);
 }
 

Parameters:

parent - Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

getAgent

public final com.google.cloud.dialogflow.v2beta1.Agent getAgent(String parent)

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Agent response = agentsClient.getAgent(parent.toString());
 }
 

Parameters:

parent - Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

getAgent

public final com.google.cloud.dialogflow.v2beta1.Agent getAgent(com.google.cloud.dialogflow.v2beta1.GetAgentRequest request)

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   GetAgentRequest request = GetAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   Agent response = agentsClient.getAgent(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getAgentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.GetAgentRequest,com.google.cloud.dialogflow.v2beta1.Agent> getAgentCallable()

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   GetAgentRequest request = GetAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Agent> future = agentsClient.getAgentCallable().futureCall(request);
   // Do something
   Agent response = future.get();
 }
 

searchAgents

public final AgentsClient.SearchAgentsPagedResponse searchAgents(com.google.cloud.dialogflow.v2beta1.ProjectName parent)

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.

Throws:

ApiException - if the remote call fails

searchAgents

public final AgentsClient.SearchAgentsPagedResponse searchAgents(String parent)

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Agent element : agentsClient.searchAgents(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.

Throws:

ApiException - if the remote call fails

searchAgents

public final AgentsClient.SearchAgentsPagedResponse searchAgents(com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest request)

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   SearchAgentsRequest request = SearchAgentsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Agent element : agentsClient.searchAgents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

searchAgentsPagedCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest,AgentsClient.SearchAgentsPagedResponse> searchAgentsPagedCallable()

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   SearchAgentsRequest request = SearchAgentsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<SearchAgentsPagedResponse> future = agentsClient.searchAgentsPagedCallable().futureCall(request);
   // Do something
   for (Agent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

searchAgentsCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.SearchAgentsRequest,com.google.cloud.dialogflow.v2beta1.SearchAgentsResponse> searchAgentsCallable()

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   SearchAgentsRequest request = SearchAgentsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     SearchAgentsResponse response = agentsClient.searchAgentsCallable().call(request);
     for (Agent element : response.getAgentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

trainAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> trainAgentAsync(com.google.cloud.dialogflow.v2beta1.ProjectName parent)

Trains the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   agentsClient.trainAgentAsync(parent).get();
 }
 

Parameters:

parent - Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

trainAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> trainAgentAsync(String parent)

Trains the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   agentsClient.trainAgentAsync(parent.toString()).get();
 }
 

Parameters:

parent - Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

trainAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> trainAgentAsync(com.google.cloud.dialogflow.v2beta1.TrainAgentRequest request)

Trains the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   TrainAgentRequest request = TrainAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   agentsClient.trainAgentAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

trainAgentOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2beta1.TrainAgentRequest,Empty,Struct> trainAgentOperationCallable()

Trains the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   TrainAgentRequest request = TrainAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<Empty, Struct> future = agentsClient.trainAgentOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

trainAgentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.TrainAgentRequest,Operation> trainAgentCallable()

Trains the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   TrainAgentRequest request = TrainAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = agentsClient.trainAgentCallable().futureCall(request);
   // Do something
   future.get();
 }
 

exportAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct> exportAgentAsync(com.google.cloud.dialogflow.v2beta1.ProjectName parent)

Exports the specified agent to a ZIP file.

Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
 }
 

Parameters:

parent - Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

exportAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct> exportAgentAsync(String parent)

Exports the specified agent to a ZIP file.

Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ExportAgentResponse response = agentsClient.exportAgentAsync(parent.toString()).get();
 }
 

Parameters:

parent - Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.

Throws:

ApiException - if the remote call fails

exportAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct> exportAgentAsync(com.google.cloud.dialogflow.v2beta1.ExportAgentRequest request)

Exports the specified agent to a ZIP file.

Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ExportAgentRequest request = ExportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ExportAgentResponse response = agentsClient.exportAgentAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

exportAgentOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2beta1.ExportAgentRequest,com.google.cloud.dialogflow.v2beta1.ExportAgentResponse,Struct> exportAgentOperationCallable()

Exports the specified agent to a ZIP file.

Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ExportAgentRequest request = ExportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<ExportAgentResponse, Struct> future = agentsClient.exportAgentOperationCallable().futureCall(request);
   // Do something
   ExportAgentResponse response = future.get();
 }
 

exportAgentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.ExportAgentRequest,Operation> exportAgentCallable()

Exports the specified agent to a ZIP file.

Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ExportAgentRequest request = ExportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = agentsClient.exportAgentCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

importAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> importAgentAsync(com.google.cloud.dialogflow.v2beta1.ImportAgentRequest request)

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ImportAgentRequest request = ImportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   agentsClient.importAgentAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

importAgentOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2beta1.ImportAgentRequest,Empty,Struct> importAgentOperationCallable()

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ImportAgentRequest request = ImportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<Empty, Struct> future = agentsClient.importAgentOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

importAgentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.ImportAgentRequest,Operation> importAgentCallable()

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ImportAgentRequest request = ImportAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = agentsClient.importAgentCallable().futureCall(request);
   // Do something
   future.get();
 }
 

restoreAgentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> restoreAgentAsync(com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest request)

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   RestoreAgentRequest request = RestoreAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   agentsClient.restoreAgentAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

restoreAgentOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest,Empty,Struct> restoreAgentOperationCallable()

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   RestoreAgentRequest request = RestoreAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<Empty, Struct> future = agentsClient.restoreAgentOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

restoreAgentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2beta1.RestoreAgentRequest,Operation> restoreAgentCallable()

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   RestoreAgentRequest request = RestoreAgentRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = agentsClient.restoreAgentCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException