public abstract class FlowsClient
Flows client wrapper, for convenient use.
Inheritance
System.Object > FlowsClientNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Remarks
Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Flows service, which is a host of "dialogflow.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
System.String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default Flows scopes.
Property Value | |
---|---|
Type | Description |
System.Collections.Generic.IReadOnlyList<System.String> |
The default Flows scopes are:
GrpcClient
public virtual Flows.FlowsClient GrpcClient { get; }
The underlying gRPC Flows client
Property Value | |
---|---|
Type | Description |
Flows.FlowsClient |
TrainFlowOperationsClient
public virtual OperationsClient TrainFlowOperationsClient { get; }
The long-running operations client for TrainFlow
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.OperationsClient |
Methods
Create()
public static FlowsClient Create()
Synchronously creates a FlowsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FlowsClientBuilder.
Returns | |
---|---|
Type | Description |
FlowsClient | The created FlowsClient. |
CreateAsync(CancellationToken)
public static Task<FlowsClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a FlowsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FlowsClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<FlowsClient> | The task representing the created FlowsClient. |
CreateFlow(AgentName, Flow, CallSettings)
public virtual Flow CreateFlow(AgentName parent, Flow flow, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
CreateFlow(CreateFlowRequest, CallSettings)
public virtual Flow CreateFlow(CreateFlowRequest request, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
CreateFlow(String, Flow, CallSettings)
public virtual Flow CreateFlow(string parent, Flow flow, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
CreateFlowAsync(AgentName, Flow, CallSettings)
public virtual Task<Flow> CreateFlowAsync(AgentName parent, Flow flow, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
CreateFlowAsync(AgentName, Flow, CancellationToken)
public virtual Task<Flow> CreateFlowAsync(AgentName parent, Flow flow, CancellationToken cancellationToken)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
CreateFlowAsync(CreateFlowRequest, CallSettings)
public virtual Task<Flow> CreateFlowAsync(CreateFlowRequest request, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
CreateFlowAsync(CreateFlowRequest, CancellationToken)
public virtual Task<Flow> CreateFlowAsync(CreateFlowRequest request, CancellationToken cancellationToken)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateFlowRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
CreateFlowAsync(String, Flow, CallSettings)
public virtual Task<Flow> CreateFlowAsync(string parent, Flow flow, CallSettings callSettings = null)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
CreateFlowAsync(String, Flow, CancellationToken)
public virtual Task<Flow> CreateFlowAsync(string parent, Flow flow, CancellationToken cancellationToken)
Creates a flow in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a flow for.
Format: |
flow | Flow Required. The flow to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
DeleteFlow(DeleteFlowRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteFlow(FlowName, CallSettings)
public virtual void DeleteFlow(FlowName name, CallSettings callSettings = null)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteFlow(String, CallSettings)
public virtual void DeleteFlow(string name, CallSettings callSettings = null)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteFlowAsync(DeleteFlowRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteFlowAsync(DeleteFlowRequest, CancellationToken)
public virtual Task DeleteFlowAsync(DeleteFlowRequest request, CancellationToken cancellationToken)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
request | DeleteFlowRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteFlowAsync(FlowName, CallSettings)
public virtual Task DeleteFlowAsync(FlowName name, CallSettings callSettings = null)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteFlowAsync(FlowName, CancellationToken)
public virtual Task DeleteFlowAsync(FlowName name, CancellationToken cancellationToken)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to delete.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteFlowAsync(String, CallSettings)
public virtual Task DeleteFlowAsync(string name, CallSettings callSettings = null)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteFlowAsync(String, CancellationToken)
public virtual Task DeleteFlowAsync(string name, CancellationToken cancellationToken)
Deletes a specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to delete.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
GetFlow(FlowName, CallSettings)
public virtual Flow GetFlow(FlowName name, CallSettings callSettings = null)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to get.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
GetFlow(GetFlowRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
GetFlow(String, CallSettings)
public virtual Flow GetFlow(string name, CallSettings callSettings = null)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to get.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
GetFlowAsync(FlowName, CallSettings)
public virtual Task<Flow> GetFlowAsync(FlowName name, CallSettings callSettings = null)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to get.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
GetFlowAsync(FlowName, CancellationToken)
public virtual Task<Flow> GetFlowAsync(FlowName name, CancellationToken cancellationToken)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The name of the flow to get.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
GetFlowAsync(GetFlowRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
GetFlowAsync(GetFlowRequest, CancellationToken)
public virtual Task<Flow> GetFlowAsync(GetFlowRequest request, CancellationToken cancellationToken)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
request | GetFlowRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
GetFlowAsync(String, CallSettings)
public virtual Task<Flow> GetFlowAsync(string name, CallSettings callSettings = null)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to get.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
GetFlowAsync(String, CancellationToken)
public virtual Task<Flow> GetFlowAsync(string name, CancellationToken cancellationToken)
Retrieves the specified flow.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the flow to get.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
ListFlows(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListFlowsResponse, Flow> ListFlows(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all flows in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent containing the flows.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListFlowsResponse, Flow> | A pageable sequence of Flow resources. |
ListFlows(ListFlowsRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListFlowsResponse, Flow> | A pageable sequence of Flow resources. |
ListFlows(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListFlowsResponse, Flow> ListFlows(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all flows in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent containing the flows.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListFlowsResponse, Flow> | A pageable sequence of Flow resources. |
ListFlowsAsync(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListFlowsResponse, Flow> ListFlowsAsync(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all flows in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent containing the flows.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListFlowsResponse, Flow> | A pageable asynchronous sequence of Flow resources. |
ListFlowsAsync(ListFlowsRequest, CallSettings)
public virtual 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 | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListFlowsResponse, Flow> | A pageable asynchronous sequence of Flow resources. |
ListFlowsAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListFlowsResponse, Flow> ListFlowsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all flows in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent containing the flows.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListFlowsResponse, Flow> | A pageable asynchronous sequence of Flow resources. |
PollOnceTrainFlow(String, CallSettings)
public virtual Operation<Empty, Struct> PollOnceTrainFlow(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of TrainFlow
.
Parameters | |
---|---|
Name | Description |
operationName | System.String The name of a previously invoked operation. Must not be |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct> | The result of polling the operation. |
PollOnceTrainFlowAsync(String, CallSettings)
public virtual Task<Operation<Empty, Struct>> PollOnceTrainFlowAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
TrainFlow
.
Parameters | |
---|---|
Name | Description |
operationName | System.String The name of a previously invoked operation. Must not be |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A task representing the result of polling the operation. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
TrainFlow(FlowName, CallSettings)
public virtual Operation<Empty, Struct> TrainFlow(FlowName name, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The flow to train.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct> | The RPC response. |
TrainFlow(TrainFlowRequest, CallSettings)
public virtual Operation<Empty, Struct> TrainFlow(TrainFlowRequest request, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
request | TrainFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct> | The RPC response. |
TrainFlow(String, CallSettings)
public virtual Operation<Empty, Struct> TrainFlow(string name, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The flow to train.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct> | The RPC response. |
TrainFlowAsync(FlowName, CallSettings)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(FlowName name, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The flow to train.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
TrainFlowAsync(FlowName, CancellationToken)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(FlowName name, CancellationToken cancellationToken)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | FlowName Required. The flow to train.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
TrainFlowAsync(TrainFlowRequest, CallSettings)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(TrainFlowRequest request, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
request | TrainFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
TrainFlowAsync(TrainFlowRequest, CancellationToken)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(TrainFlowRequest request, CancellationToken cancellationToken)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
request | TrainFlowRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
TrainFlowAsync(String, CallSettings)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(string name, CallSettings callSettings = null)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The flow to train.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
TrainFlowAsync(String, CancellationToken)
public virtual Task<Operation<Empty, Struct>> TrainFlowAsync(string name, CancellationToken cancellationToken)
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The flow to train.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>> | A Task containing the RPC response. |
UpdateFlow(Flow, FieldMask, CallSettings)
public virtual Flow UpdateFlow(Flow flow, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
flow | Flow Required. The flow to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated. If |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
UpdateFlow(UpdateFlowRequest, CallSettings)
public virtual Flow UpdateFlow(UpdateFlowRequest request, CallSettings callSettings = null)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
request | UpdateFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Flow | The RPC response. |
UpdateFlowAsync(Flow, FieldMask, CallSettings)
public virtual Task<Flow> UpdateFlowAsync(Flow flow, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
flow | Flow Required. The flow to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated. If |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
UpdateFlowAsync(Flow, FieldMask, CancellationToken)
public virtual Task<Flow> UpdateFlowAsync(Flow flow, FieldMask updateMask, CancellationToken cancellationToken)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
flow | Flow Required. The flow to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated. If |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
UpdateFlowAsync(UpdateFlowRequest, CallSettings)
public virtual Task<Flow> UpdateFlowAsync(UpdateFlowRequest request, CallSettings callSettings = null)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
request | UpdateFlowRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |
UpdateFlowAsync(UpdateFlowRequest, CancellationToken)
public virtual Task<Flow> UpdateFlowAsync(UpdateFlowRequest request, CancellationToken cancellationToken)
Updates the specified flow.
Parameters | |
---|---|
Name | Description |
request | UpdateFlowRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Flow> | A Task containing the RPC response. |