public static final class FlowsGrpc.FlowsBlockingV2Stub extends AbstractBlockingStub<FlowsGrpc.FlowsBlockingV2Stub>A stub to allow clients to do synchronous rpc calls to service Flows.
Service for managing Flows.
Inheritance
java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > FlowsGrpc.FlowsBlockingV2StubMethods
build(Channel channel, CallOptions callOptions)
protected FlowsGrpc.FlowsBlockingV2Stub build(Channel channel, CallOptions callOptions)| Parameters | |
|---|---|
| Name | Description |
channel |
io.grpc.Channel |
callOptions |
io.grpc.CallOptions |
| Returns | |
|---|---|
| Type | Description |
FlowsGrpc.FlowsBlockingV2Stub |
|
createFlow(CreateFlowRequest request)
public 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 |
Flow |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
deleteFlow(DeleteFlowRequest request)
public Empty deleteFlow(DeleteFlowRequest request)Deletes a specified flow.
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteFlowRequest |
| Returns | |
|---|---|
| Type | Description |
Empty |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
exportFlow(ExportFlowRequest request)
public 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 messageresponse: 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 |
Operation |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
getFlow(GetFlowRequest request)
public Flow getFlow(GetFlowRequest request)Retrieves the specified flow.
| Parameter | |
|---|---|
| Name | Description |
request |
GetFlowRequest |
| Returns | |
|---|---|
| Type | Description |
Flow |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
getFlowValidationResult(GetFlowValidationResultRequest request)
public 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 |
FlowValidationResult |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
importFlow(ImportFlowRequest request)
public 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:
metadata: An empty Struct messageresponse: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation.
| Parameter | |
|---|---|
| Name | Description |
request |
ImportFlowRequest |
| Returns | |
|---|---|
| Type | Description |
Operation |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
listFlows(ListFlowsRequest request)
public ListFlowsResponse listFlows(ListFlowsRequest request)Returns the list of all flows in the specified agent.
| Parameter | |
|---|---|
| Name | Description |
request |
ListFlowsRequest |
| Returns | |
|---|---|
| Type | Description |
ListFlowsResponse |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
trainFlow(TrainFlowRequest request)
public 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:
metadata: An empty Struct messageresponse: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.
| Parameter | |
|---|---|
| Name | Description |
request |
TrainFlowRequest |
| Returns | |
|---|---|
| Type | Description |
Operation |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
updateFlow(UpdateFlowRequest request)
public 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 |
Flow |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
validateFlow(ValidateFlowRequest request)
public 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 |
FlowValidationResult |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|