Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Flows.FlowsClient (1.0.0)

public class FlowsClient : ClientBase<Flows.FlowsClient>

Client for Flows

Inheritance

System.Object > Grpc.Core.ClientBase > Grpc.Core.ClientBase<Flows.FlowsClient> > Flows.FlowsClient

Inherited Members

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Flows.FlowsClient>.WithHost(System.String)

Grpc.Core.ClientBase.CallInvoker

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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`	`Grpc.Core.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`	`Grpc.Core.ChannelBase` The channel to use to make remote calls.

FlowsClient(ClientBase.ClientBaseConfiguration)

protected FlowsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`Grpc.Core.ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateFlow(CreateFlowRequest, CallOptions)

public virtual Flow CreateFlow(CreateFlowRequest request, CallOptions options)

Creates a flow in the specified agent.

Parameters
Name	Description
`request`	`CreateFlowRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Flow`	The response received from the server.

CreateFlow(CreateFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a flow in the specified agent.

Parameters
Name	Description
`request`	`CreateFlowRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.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.

Parameters
Name	Description
`request`	`CreateFlowRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	The call object.

CreateFlowAsync(CreateFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a flow in the specified agent.

Parameters
Name	Description
`request`	`CreateFlowRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type	Description
`Google.LongRunning.Operations.OperationsClient`	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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Google.Protobuf.WellKnownTypes.Empty`	The response received from the server.

DeleteFlow(DeleteFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a specified flow.

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

Returns
Type	Description
`Google.Protobuf.WellKnownTypes.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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>`	The call object.

DeleteFlowAsync(DeleteFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a specified flow.

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

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>`	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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Flow`	The response received from the server.

GetFlow(GetFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the specified flow.

Parameters
Name	Description
`request`	`GetFlowRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	The call object.

GetFlowAsync(GetFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the specified flow.

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

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`ListFlowsResponse`	The response received from the server.

ListFlows(ListFlowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the list of all flows in the specified agent.

Parameters
Name	Description
`request`	`ListFlowsRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.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`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<ListFlowsResponse>`	The call object.

ListFlowsAsync(ListFlowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the list of all flows in the specified agent.

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

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<ListFlowsResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`Grpc.Core.ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`Flows.FlowsClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Flows.FlowsClient>.NewInstance(Grpc.Core.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.

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

Returns
Type	Description
`Google.LongRunning.Operation`	The response received from the server.

TrainFlow(TrainFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Trains the specified flow. Note that only the flow in 'draft' environment is trained.

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

Returns
Type	Description
`Google.LongRunning.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.

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

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

TrainFlowAsync(TrainFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Trains the specified flow. Note that only the flow in 'draft' environment is trained.

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

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

UpdateFlow(UpdateFlowRequest, CallOptions)

public virtual Flow UpdateFlow(UpdateFlowRequest request, CallOptions options)

Updates the specified flow.

Parameters
Name	Description
`request`	`UpdateFlowRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Flow`	The response received from the server.

UpdateFlow(UpdateFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified flow.

Parameters
Name	Description
`request`	`UpdateFlowRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.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.

Parameters
Name	Description
`request`	`UpdateFlowRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	The call object.

UpdateFlowAsync(UpdateFlowRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified flow.

Parameters
Name	Description
`request`	`UpdateFlowRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Flow>`	The call object.