Interface FlowsGrpc.AsyncService (0.48.0)

public static interface FlowsGrpc.AsyncService

Service for managing Flows.

Methods

createFlow(CreateFlowRequest request, StreamObserver<Flow> responseObserver)

public default void createFlow(CreateFlowRequest request, 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.

Parameters
Name Description
request CreateFlowRequest
responseObserver io.grpc.stub.StreamObserver<Flow>

deleteFlow(DeleteFlowRequest request, StreamObserver<Empty> responseObserver)

public default void deleteFlow(DeleteFlowRequest request, StreamObserver<Empty> responseObserver)

Deletes a specified flow.

Parameters
Name Description
request DeleteFlowRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

exportFlow(ExportFlowRequest request, StreamObserver<Operation> responseObserver)

public default void exportFlow(ExportFlowRequest request, StreamObserver<Operation> responseObserver)

Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
Parameters
Name Description
request ExportFlowRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getFlow(GetFlowRequest request, StreamObserver<Flow> responseObserver)

public default void getFlow(GetFlowRequest request, StreamObserver<Flow> responseObserver)

Retrieves the specified flow.

Parameters
Name Description
request GetFlowRequest
responseObserver io.grpc.stub.StreamObserver<Flow>

getFlowValidationResult(GetFlowValidationResultRequest request, StreamObserver<FlowValidationResult> responseObserver)

public default void getFlowValidationResult(GetFlowValidationResultRequest request, StreamObserver<FlowValidationResult> responseObserver)

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

Parameters
Name Description
request GetFlowValidationResultRequest
responseObserver io.grpc.stub.StreamObserver<FlowValidationResult>

importFlow(ImportFlowRequest request, StreamObserver<Operation> responseObserver)

public default void importFlow(ImportFlowRequest request, StreamObserver<Operation> responseObserver)

Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
Name Description
request ImportFlowRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listFlows(ListFlowsRequest request, StreamObserver<ListFlowsResponse> responseObserver)

public default void listFlows(ListFlowsRequest request, StreamObserver<ListFlowsResponse> responseObserver)

Returns the list of all flows in the specified agent.

Parameters
Name Description
request ListFlowsRequest
responseObserver io.grpc.stub.StreamObserver<ListFlowsResponse>

trainFlow(TrainFlowRequest request, StreamObserver<Operation> responseObserver)

public default void trainFlow(TrainFlowRequest request, StreamObserver<Operation> responseObserver)

Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
Name Description
request TrainFlowRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateFlow(UpdateFlowRequest request, StreamObserver<Flow> responseObserver)

public default void updateFlow(UpdateFlowRequest request, StreamObserver<Flow> responseObserver)

Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateFlowRequest
responseObserver io.grpc.stub.StreamObserver<Flow>

validateFlow(ValidateFlowRequest request, StreamObserver<FlowValidationResult> responseObserver)

public default void validateFlow(ValidateFlowRequest request, 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.

Parameters
Name Description
request ValidateFlowRequest
responseObserver io.grpc.stub.StreamObserver<FlowValidationResult>