Class FlowsGrpc.FlowsFutureStub (0.40.0)

public static final class FlowsGrpc.FlowsFutureStub extends AbstractFutureStub<FlowsGrpc.FlowsFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Flows.

Service for managing Flows.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > FlowsGrpc.FlowsFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected FlowsGrpc.FlowsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
FlowsGrpc.FlowsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createFlow(CreateFlowRequest request)

public ListenableFuture<Flow> createFlow(CreateFlowRequest request)

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

Parameter
Name Description
request CreateFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Flow>

deleteFlow(DeleteFlowRequest request)

public ListenableFuture<Empty> deleteFlow(DeleteFlowRequest request)

Deletes a specified flow.

Parameter
Name Description
request DeleteFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

exportFlow(ExportFlowRequest request)

public ListenableFuture<Operation> exportFlow(ExportFlowRequest request)

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.
Parameter
Name Description
request ExportFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getFlow(GetFlowRequest request)

public ListenableFuture<Flow> getFlow(GetFlowRequest request)

Retrieves the specified flow.

Parameter
Name Description
request GetFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Flow>

getFlowValidationResult(GetFlowValidationResultRequest request)

public ListenableFuture<FlowValidationResult> getFlowValidationResult(GetFlowValidationResultRequest request)

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

Parameter
Name Description
request GetFlowValidationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FlowValidationResult>

importFlow(ImportFlowRequest request)

public ListenableFuture<Operation> importFlow(ImportFlowRequest request)

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:

Parameter
Name Description
request ImportFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listFlows(ListFlowsRequest request)

public ListenableFuture<ListFlowsResponse> listFlows(ListFlowsRequest request)

Returns the list of all flows in the specified agent.

Parameter
Name Description
request ListFlowsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListFlowsResponse>

trainFlow(TrainFlowRequest request)

public ListenableFuture<Operation> trainFlow(TrainFlowRequest request)

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:

Parameter
Name Description
request TrainFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateFlow(UpdateFlowRequest request)

public ListenableFuture<Flow> updateFlow(UpdateFlowRequest request)

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

Parameter
Name Description
request UpdateFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Flow>

validateFlow(ValidateFlowRequest request)

public ListenableFuture<FlowValidationResult> validateFlow(ValidateFlowRequest request)

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.

Parameter
Name Description
request ValidateFlowRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FlowValidationResult>