Dialogflow v3 API - Class Flows.FlowsClient (2.14.0)

Version 2.14.0

• 2.20.0 (latest)
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class Flows.FlowsClient : ClientBase<Flows.FlowsClient>

Reference documentation and code samples for the Dialogflow v3 API class Flows.FlowsClient.

Client for Flows

Inheritance

object > ClientBase > ClientBaseFlowsFlowsClient > Flows.FlowsClient

Inherited Members

ClientBase<Flows.FlowsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

FlowsClient()

protected FlowsClient()

Protected parameterless constructor to allow creation of test doubles.

FlowsClient(CallInvoker)

public FlowsClient(CallInvoker callInvoker)

Creates a new client for Flows that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

FlowsClient(ChannelBase)

public FlowsClient(ChannelBase channel)

Creates a new client for Flows

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

FlowsClient(ClientBaseConfiguration)

protected FlowsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateFlow(CreateFlowRequest, CallOptions)

public virtual Flow CreateFlow(CreateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Flow	The response received from the server.

CreateFlow(CreateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Flow CreateFlow(CreateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Flow	The response received from the server.

CreateFlowAsync(CreateFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Flow> CreateFlowAsync(CreateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

CreateFlowAsync(CreateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Flow> CreateFlowAsync(CreateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteFlow(DeleteFlowRequest, CallOptions)

public virtual Empty DeleteFlow(DeleteFlowRequest request, CallOptions options)

Deletes a specified flow.

Parameters
Name	Description
request	DeleteFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteFlow(DeleteFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteFlow(DeleteFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specified flow.

Parameters
Name	Description
request	DeleteFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteFlowAsync(DeleteFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteFlowAsync(DeleteFlowRequest request, CallOptions options)

Deletes a specified flow.

Parameters
Name	Description
request	DeleteFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteFlowAsync(DeleteFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteFlowAsync(DeleteFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specified flow.

Parameters
Name	Description
request	DeleteFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

ExportFlow(ExportFlowRequest, CallOptions)

public virtual Operation ExportFlow(ExportFlowRequest request, CallOptions options)

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][google.cloud.dialogflow.cx.v3.ExportFlowResponse]

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	ExportFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportFlow(ExportFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportFlow(ExportFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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][google.cloud.dialogflow.cx.v3.ExportFlowResponse]

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	ExportFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportFlowAsync(ExportFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportFlowAsync(ExportFlowRequest request, CallOptions options)

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][google.cloud.dialogflow.cx.v3.ExportFlowResponse]

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	ExportFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportFlowAsync(ExportFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportFlowAsync(ExportFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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][google.cloud.dialogflow.cx.v3.ExportFlowResponse]

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	ExportFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetFlow(GetFlowRequest, CallOptions)

public virtual Flow GetFlow(GetFlowRequest request, CallOptions options)

Retrieves the specified flow.

Parameters
Name	Description
request	GetFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Flow	The response received from the server.

GetFlow(GetFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Flow GetFlow(GetFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified flow.

Parameters
Name	Description
request	GetFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Flow	The response received from the server.

GetFlowAsync(GetFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Flow> GetFlowAsync(GetFlowRequest request, CallOptions options)

Retrieves the specified flow.

Parameters
Name	Description
request	GetFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

GetFlowAsync(GetFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Flow> GetFlowAsync(GetFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified flow.

Parameters
Name	Description
request	GetFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

GetFlowValidationResult(GetFlowValidationResultRequest, CallOptions)

public virtual FlowValidationResult GetFlowValidationResult(GetFlowValidationResultRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetFlowValidationResultRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FlowValidationResult	The response received from the server.

GetFlowValidationResult(GetFlowValidationResultRequest, Metadata, DateTime?, CancellationToken)

public virtual FlowValidationResult GetFlowValidationResult(GetFlowValidationResultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetFlowValidationResultRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FlowValidationResult	The response received from the server.

GetFlowValidationResultAsync(GetFlowValidationResultRequest, CallOptions)

public virtual AsyncUnaryCall<FlowValidationResult> GetFlowValidationResultAsync(GetFlowValidationResultRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetFlowValidationResultRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFlowValidationResult	The call object.

GetFlowValidationResultAsync(GetFlowValidationResultRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FlowValidationResult> GetFlowValidationResultAsync(GetFlowValidationResultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetFlowValidationResultRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFlowValidationResult	The call object.

ImportFlow(ImportFlowRequest, CallOptions)

public virtual Operation ImportFlow(ImportFlowRequest request, CallOptions options)

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 message
• response: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]

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

Parameters
Name	Description
request	ImportFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ImportFlow(ImportFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportFlow(ImportFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 message
• response: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]

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

Parameters
Name	Description
request	ImportFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ImportFlowAsync(ImportFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportFlowAsync(ImportFlowRequest request, CallOptions options)

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 message
• response: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]

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

Parameters
Name	Description
request	ImportFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportFlowAsync(ImportFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportFlowAsync(ImportFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 message
• response: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]

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

Parameters
Name	Description
request	ImportFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ListFlows(ListFlowsRequest, CallOptions)

public virtual ListFlowsResponse ListFlows(ListFlowsRequest request, CallOptions options)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	ListFlowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListFlowsResponse	The response received from the server.

ListFlows(ListFlowsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFlowsResponse ListFlows(ListFlowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	ListFlowsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListFlowsResponse	The response received from the server.

ListFlowsAsync(ListFlowsRequest, CallOptions)

public virtual AsyncUnaryCall<ListFlowsResponse> ListFlowsAsync(ListFlowsRequest request, CallOptions options)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	ListFlowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListFlowsResponse	The call object.

ListFlowsAsync(ListFlowsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFlowsResponse> ListFlowsAsync(ListFlowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	ListFlowsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListFlowsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Flows.FlowsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
FlowsFlowsClient

Overrides

ClientBase<Flows.FlowsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

TrainFlow(TrainFlowRequest, CallOptions)

public virtual Operation TrainFlow(TrainFlowRequest request, CallOptions options)

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 message
• response: An Empty message

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

Parameters
Name	Description
request	TrainFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

TrainFlow(TrainFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TrainFlow(TrainFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 message
• response: An Empty message

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

Parameters
Name	Description
request	TrainFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

TrainFlowAsync(TrainFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TrainFlowAsync(TrainFlowRequest request, CallOptions options)

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 message
• response: An Empty message

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

Parameters
Name	Description
request	TrainFlowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

TrainFlowAsync(TrainFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TrainFlowAsync(TrainFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 message
• response: An Empty message

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

Parameters
Name	Description
request	TrainFlowRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateFlow(UpdateFlowRequest, CallOptions)

public virtual Flow UpdateFlow(UpdateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Flow	The response received from the server.

UpdateFlow(UpdateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual Flow UpdateFlow(UpdateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Flow	The response received from the server.

UpdateFlowAsync(UpdateFlowRequest, CallOptions)

public virtual AsyncUnaryCall<Flow> UpdateFlowAsync(UpdateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

UpdateFlowAsync(UpdateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Flow> UpdateFlowAsync(UpdateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFlow	The call object.

ValidateFlow(ValidateFlowRequest, CallOptions)

public virtual FlowValidationResult ValidateFlow(ValidateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FlowValidationResult	The response received from the server.

ValidateFlow(ValidateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual FlowValidationResult ValidateFlow(ValidateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FlowValidationResult	The response received from the server.

ValidateFlowAsync(ValidateFlowRequest, CallOptions)

public virtual AsyncUnaryCall<FlowValidationResult> ValidateFlowAsync(ValidateFlowRequest request, CallOptions options)

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 The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFlowValidationResult	The call object.

ValidateFlowAsync(ValidateFlowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FlowValidationResult> ValidateFlowAsync(ValidateFlowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFlowValidationResult	The call object.