com.google.cloud.dialogflow.cx.v3

Interface FlowsGrpc.AsyncService

All Known Implementing Classes:

FlowsGrpc.FlowsImplBase

Enclosing class:

FlowsGrpc

public static interface FlowsGrpc.AsyncService

 Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
 

Method Summary

Modifier and Type	Method and Description
default void	createFlow(CreateFlowRequest request, io.grpc.stub.StreamObserver<Flow> responseObserver) Creates a flow in the specified agent.
default void	deleteFlow(DeleteFlowRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a specified flow.
default void	exportFlow(ExportFlowRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Exports the specified flow to a binary file.
default void	getFlow(GetFlowRequest request, io.grpc.stub.StreamObserver<Flow> responseObserver) Retrieves the specified flow.
default void	getFlowValidationResult(GetFlowValidationResultRequest request, io.grpc.stub.StreamObserver<FlowValidationResult> responseObserver) Gets the latest flow validation result.
default void	importFlow(ImportFlowRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Imports the specified flow to the specified agent from a binary file.
default void	listFlows(ListFlowsRequest request, io.grpc.stub.StreamObserver<ListFlowsResponse> responseObserver) Returns the list of all flows in the specified agent.
default void	trainFlow(TrainFlowRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Trains the specified flow.
default void	updateFlow(UpdateFlowRequest request, io.grpc.stub.StreamObserver<Flow> responseObserver) Updates the specified flow.
default void	validateFlow(ValidateFlowRequest request, io.grpc.stub.StreamObserver<FlowValidationResult> responseObserver) Validates the specified flow and creates or updates validation results.

Method Detail

createFlow

default void createFlow(CreateFlowRequest request,
                        io.grpc.stub.StreamObserver<Flow> responseObserver)

 Creates a flow in the specified agent.
 Note: You should always train a flow prior to sending it queries. See the
 [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
 

deleteFlow

default void deleteFlow(DeleteFlowRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes a specified flow.
 

listFlows

default void listFlows(ListFlowsRequest request,
                       io.grpc.stub.StreamObserver<ListFlowsResponse> responseObserver)

 Returns the list of all flows in the specified agent.
 

getFlow

default void getFlow(GetFlowRequest request,
                     io.grpc.stub.StreamObserver<Flow> responseObserver)

 Retrieves the specified flow.
 

updateFlow

default void updateFlow(UpdateFlowRequest request,
                        io.grpc.stub.StreamObserver<Flow> responseObserver)

 Updates the specified flow.
 Note: You should always train a flow prior to sending it queries. See the
 [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
 

trainFlow

default void trainFlow(TrainFlowRequest request,
                       io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Trains the specified flow. Note that only the flow in 'draft' environment
 is trained.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 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 a flow prior to sending it queries. See the
 [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
 

validateFlow

default void validateFlow(ValidateFlowRequest request,
                          io.grpc.stub.StreamObserver<FlowValidationResult> responseObserver)

 Validates the specified flow and creates or updates validation results.
 Please call this API after the training is completed to get the complete
 validation results.
 

getFlowValidationResult

default void getFlowValidationResult(GetFlowValidationResultRequest request,
                                     io.grpc.stub.StreamObserver<FlowValidationResult> responseObserver)

 Gets the latest flow validation result. Flow validation is performed
 when ValidateFlow is called.
 

importFlow

default void importFlow(ImportFlowRequest request,
                        io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Imports the specified flow to the specified agent from a binary file.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 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`:
 [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
 Note: You should always train a flow prior to sending it queries. See the
 [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
 

exportFlow

default void exportFlow(ExportFlowRequest request,
                        io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Exports the specified flow to a binary file.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 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`:
 [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
 Note that resources (e.g. intents, entities, webhooks) that the flow
 references will also be exported.