com.google.cloud.dialogflow.v2

Class AgentsGrpc.AgentsFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<AgentsGrpc.AgentsFutureStub>

com.google.cloud.dialogflow.v2.AgentsGrpc.AgentsFutureStub

Enclosing class:

AgentsGrpc

public static final class AgentsGrpc.AgentsFutureStub
extends AbstractFutureStub<AgentsGrpc.AgentsFutureStub>

 Service for managing [Agents][google.cloud.dialogflow.v2.Agent].
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected AgentsGrpc.AgentsFutureStub	build(Channel channel, CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Empty>	deleteAgent(DeleteAgentRequest request) Deletes the specified agent.
com.google.common.util.concurrent.ListenableFuture<Operation>	exportAgent(ExportAgentRequest request) Exports the specified agent to a ZIP file.
com.google.common.util.concurrent.ListenableFuture<Agent>	getAgent(GetAgentRequest request) Retrieves the specified agent.
com.google.common.util.concurrent.ListenableFuture<ValidationResult>	getValidationResult(GetValidationResultRequest request) Gets agent validation result.
com.google.common.util.concurrent.ListenableFuture<Operation>	importAgent(ImportAgentRequest request) Imports the specified agent from a ZIP file.
com.google.common.util.concurrent.ListenableFuture<Operation>	restoreAgent(RestoreAgentRequest request) Restores the specified agent from a ZIP file.
com.google.common.util.concurrent.ListenableFuture<SearchAgentsResponse>	searchAgents(SearchAgentsRequest request) Returns the list of agents.
com.google.common.util.concurrent.ListenableFuture<Agent>	setAgent(SetAgentRequest request) Creates/updates the specified agent.
com.google.common.util.concurrent.ListenableFuture<Operation>	trainAgent(TrainAgentRequest request) Trains the specified agent.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected AgentsGrpc.AgentsFutureStub build(Channel channel,
                                            CallOptions callOptions)

Specified by:

build in class AbstractStub<AgentsGrpc.AgentsFutureStub>

getAgent

public com.google.common.util.concurrent.ListenableFuture<Agent> getAgent(GetAgentRequest request)

 Retrieves the specified agent.
 

setAgent

public com.google.common.util.concurrent.ListenableFuture<Agent> setAgent(SetAgentRequest request)

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

deleteAgent

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteAgent(DeleteAgentRequest request)

 Deletes the specified agent.
 

searchAgents

public com.google.common.util.concurrent.ListenableFuture<SearchAgentsResponse> searchAgents(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).
 

trainAgent

public com.google.common.util.concurrent.ListenableFuture<Operation> trainAgent(TrainAgentRequest request)

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

exportAgent

public com.google.common.util.concurrent.ListenableFuture<Operation> exportAgent(ExportAgentRequest request)

 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]
 

importAgent

public com.google.common.util.concurrent.ListenableFuture<Operation> importAgent(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][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).
 

restoreAgent

public com.google.common.util.concurrent.ListenableFuture<Operation> restoreAgent(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. 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).
 

getValidationResult

public com.google.common.util.concurrent.ListenableFuture<ValidationResult> getValidationResult(GetValidationResultRequest request)

 Gets agent validation result. Agent validation is performed during
 training time and is updated automatically when training is completed.