Class FlowsGrpc.FlowsStub (0.13.0)

public static final class FlowsGrpc.FlowsStub extends AbstractAsyncStub<FlowsGrpc.FlowsStub>

Service for managing Flows.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > FlowsGrpc.FlowsStub

Methods

build(Channel channel, CallOptions callOptions)

protected FlowsGrpc.FlowsStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
FlowsGrpc.FlowsStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createFlow(CreateFlowRequest request, StreamObserver<Flow> responseObserver)

public 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
NameDescription
requestCreateFlowRequest
responseObserverio.grpc.stub.StreamObserver<Flow>

deleteFlow(DeleteFlowRequest request, StreamObserver<Empty> responseObserver)

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

Deletes a specified flow.

Parameters
NameDescription
requestDeleteFlowRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

exportFlow(ExportFlowRequest request, StreamObserver<Operation> responseObserver)

public 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
NameDescription
requestExportFlowRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getFlow(GetFlowRequest request, StreamObserver<Flow> responseObserver)

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

Retrieves the specified flow.

Parameters
NameDescription
requestGetFlowRequest
responseObserverio.grpc.stub.StreamObserver<Flow>

getFlowValidationResult(GetFlowValidationResultRequest request, StreamObserver<FlowValidationResult> responseObserver)

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

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

Parameters
NameDescription
requestGetFlowValidationResultRequest
responseObserverio.grpc.stub.StreamObserver<FlowValidationResult>

importFlow(ImportFlowRequest request, StreamObserver<Operation> responseObserver)

public 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
NameDescription
requestImportFlowRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

listFlows(ListFlowsRequest request, StreamObserver<ListFlowsResponse> responseObserver)

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

Returns the list of all flows in the specified agent.

Parameters
NameDescription
requestListFlowsRequest
responseObserverio.grpc.stub.StreamObserver<ListFlowsResponse>

trainFlow(TrainFlowRequest request, StreamObserver<Operation> responseObserver)

public 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
NameDescription
requestTrainFlowRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateFlow(UpdateFlowRequest request, StreamObserver<Flow> responseObserver)

public 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
NameDescription
requestUpdateFlowRequest
responseObserverio.grpc.stub.StreamObserver<Flow>

validateFlow(ValidateFlowRequest request, StreamObserver<FlowValidationResult> responseObserver)

public 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
NameDescription
requestValidateFlowRequest
responseObserverio.grpc.stub.StreamObserver<FlowValidationResult>