Dialogflow v3 API - Class FlowsClientImpl (2.18.0)

public sealed class FlowsClientImpl : FlowsClient

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

Flows client wrapper implementation, for convenient use.

Inheritance

object > FlowsClient > FlowsClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].

Constructors

FlowsClientImpl(FlowsClient, FlowsSettings, ILogger)

public FlowsClientImpl(Flows.FlowsClient grpcClient, FlowsSettings settings, ILogger logger)

Constructs a client wrapper for the Flows service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient FlowsFlowsClient

The underlying gRPC client.
settings FlowsSettings

The base FlowsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

ExportFlowOperationsClient

public override OperationsClient ExportFlowOperationsClient { get; }

The long-running operations client for ExportFlow.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Flows.FlowsClient GrpcClient { get; }

The underlying gRPC Flows client

Property Value
Type Description
FlowsFlowsClient
Overrides

ImportFlowOperationsClient

public override OperationsClient ImportFlowOperationsClient { get; }

The long-running operations client for ImportFlow.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

TrainFlowOperationsClient

public override OperationsClient TrainFlowOperationsClient { get; }

The long-running operations client for TrainFlow.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateFlow(CreateFlowRequest, CallSettings)

public override Flow CreateFlow(CreateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Flow

The RPC response.
Overrides

CreateFlowAsync(CreateFlowRequest, CallSettings)

public override Task<Flow> CreateFlowAsync(CreateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFlow

A Task containing the RPC response.
Overrides

DeleteFlow(DeleteFlowRequest, CallSettings)

public override void DeleteFlow(DeleteFlowRequest request, CallSettings callSettings = null)

Deletes a specified flow.

Parameters
Name Description
request DeleteFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteFlowAsync(DeleteFlowRequest, CallSettings)

public override Task DeleteFlowAsync(DeleteFlowRequest request, CallSettings callSettings = null)

Deletes a specified flow.

Parameters
Name Description
request DeleteFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ExportFlow(ExportFlowRequest, CallSettings)

public override Operation<ExportFlowResponse, Struct> ExportFlow(ExportFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExportFlowResponseStruct

The RPC response.
Overrides

ExportFlowAsync(ExportFlowRequest, CallSettings)

public override Task<Operation<ExportFlowResponse, Struct>> ExportFlowAsync(ExportFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExportFlowResponseStruct

A Task containing the RPC response.
Overrides

GetFlow(GetFlowRequest, CallSettings)

public override Flow GetFlow(GetFlowRequest request, CallSettings callSettings = null)

Retrieves the specified flow.

Parameters
Name Description
request GetFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Flow

The RPC response.
Overrides

GetFlowAsync(GetFlowRequest, CallSettings)

public override Task<Flow> GetFlowAsync(GetFlowRequest request, CallSettings callSettings = null)

Retrieves the specified flow.

Parameters
Name Description
request GetFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFlow

A Task containing the RPC response.
Overrides

GetFlowValidationResult(GetFlowValidationResultRequest, CallSettings)

public override FlowValidationResult GetFlowValidationResult(GetFlowValidationResultRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetFlowValidationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FlowValidationResult

The RPC response.
Overrides

GetFlowValidationResultAsync(GetFlowValidationResultRequest, CallSettings)

public override Task<FlowValidationResult> GetFlowValidationResultAsync(GetFlowValidationResultRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetFlowValidationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFlowValidationResult

A Task containing the RPC response.
Overrides

ImportFlow(ImportFlowRequest, CallSettings)

public override Operation<ImportFlowResponse, Struct> ImportFlow(ImportFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportFlowResponseStruct

The RPC response.
Overrides

ImportFlowAsync(ImportFlowRequest, CallSettings)

public override Task<Operation<ImportFlowResponse, Struct>> ImportFlowAsync(ImportFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportFlowResponseStruct

A Task containing the RPC response.
Overrides

ListFlows(ListFlowsRequest, CallSettings)

public override PagedEnumerable<ListFlowsResponse, Flow> ListFlows(ListFlowsRequest request, CallSettings callSettings = null)

Returns the list of all flows in the specified agent.

Parameters
Name Description
request ListFlowsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFlowsResponseFlow

A pageable sequence of Flow resources.
Overrides

ListFlowsAsync(ListFlowsRequest, CallSettings)

public override PagedAsyncEnumerable<ListFlowsResponse, Flow> ListFlowsAsync(ListFlowsRequest request, CallSettings callSettings = null)

Returns the list of all flows in the specified agent.

Parameters
Name Description
request ListFlowsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFlowsResponseFlow

A pageable asynchronous sequence of Flow resources.
Overrides

TrainFlow(TrainFlowRequest, CallSettings)

public override Operation<Empty, Struct> TrainFlow(TrainFlowRequest request, CallSettings callSettings = null)

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:

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

Parameters
Name Description
request TrainFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyStruct

The RPC response.
Overrides

TrainFlowAsync(TrainFlowRequest, CallSettings)

public override Task<Operation<Empty, Struct>> TrainFlowAsync(TrainFlowRequest request, CallSettings callSettings = null)

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:

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

Parameters
Name Description
request TrainFlowRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.
Overrides

UpdateFlow(UpdateFlowRequest, CallSettings)

public override Flow UpdateFlow(UpdateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Flow

The RPC response.
Overrides

UpdateFlowAsync(UpdateFlowRequest, CallSettings)

public override Task<Flow> UpdateFlowAsync(UpdateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFlow

A Task containing the RPC response.
Overrides

ValidateFlow(ValidateFlowRequest, CallSettings)

public override FlowValidationResult ValidateFlow(ValidateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FlowValidationResult

The RPC response.
Overrides

ValidateFlowAsync(ValidateFlowRequest, CallSettings)

public override Task<FlowValidationResult> ValidateFlowAsync(ValidateFlowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFlowValidationResult

A Task containing the RPC response.
Overrides