Class FlowsClientImpl (1.5.0)

public sealed class FlowsClientImpl : FlowsClient

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(Flows.FlowsClient, FlowsSettings)

public FlowsClientImpl(Flows.FlowsClient grpcClient, FlowsSettings settings)

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

Parameters
NameDescription
grpcClientFlows.FlowsClient

The underlying gRPC client.

settingsFlowsSettings

The base FlowsSettings used within this client.

Properties

ExportFlowOperationsClient

public override OperationsClient ExportFlowOperationsClient { get; }

The long-running operations client for ExportFlow.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Flows.FlowsClient GrpcClient { get; }

The underlying gRPC Flows client

Property Value
TypeDescription
Flows.FlowsClient
Overrides

ImportFlowOperationsClient

public override OperationsClient ImportFlowOperationsClient { get; }

The long-running operations client for ImportFlow.

Property Value
TypeDescription
OperationsClient
Overrides

TrainFlowOperationsClient

public override OperationsClient TrainFlowOperationsClient { get; }

The long-running operations client for TrainFlow.

Property Value
TypeDescription
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
NameDescription
requestCreateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestCreateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Flow>

A Task containing the RPC response.

Overrides

DeleteFlow(DeleteFlowRequest, CallSettings)

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

Deletes a specified flow.

Parameters
NameDescription
requestDeleteFlowRequest

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

callSettingsCallSettings

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
NameDescription
requestDeleteFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestExportFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ExportFlowResponse, Struct>

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
NameDescription
requestExportFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ExportFlowResponse, Struct>>

A Task containing the RPC response.

Overrides

GetFlow(GetFlowRequest, CallSettings)

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

Retrieves the specified flow.

Parameters
NameDescription
requestGetFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Flow

The RPC response.

Overrides

GetFlowAsync(GetFlowRequest, CallSettings)

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

Retrieves the specified flow.

Parameters
NameDescription
requestGetFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Flow>

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
NameDescription
requestGetFlowValidationResultRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetFlowValidationResultRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FlowValidationResult>

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
NameDescription
requestImportFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ImportFlowResponse, Struct>

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
NameDescription
requestImportFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ImportFlowResponse, Struct>>

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
NameDescription
requestListFlowsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListFlowsResponse, Flow>

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
NameDescription
requestListFlowsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListFlowsResponse, Flow>

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
NameDescription
requestTrainFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, Struct>

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
NameDescription
requestTrainFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, Struct>>

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
NameDescription
requestUpdateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestUpdateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Flow>

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
NameDescription
requestValidateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestValidateFlowRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FlowValidationResult>

A Task containing the RPC response.

Overrides