Class FlowsClient (1.4.0)

public abstract class FlowsClient

Flows client wrapper, for convenient use.

Inheritance

Object > FlowsClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

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].

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
`String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Flows scopes.

Property Value
Type	Description
`IReadOnlyList<String>`

Remarks

The default Flows scopes are:

ExportFlowOperationsClient

public virtual OperationsClient ExportFlowOperationsClient { get; }

The long-running operations client for ExportFlow.

Property Value
Type	Description
`OperationsClient`

GrpcClient

public virtual Flows.FlowsClient GrpcClient { get; }

The underlying gRPC Flows client

Property Value
Type	Description
`Flows.FlowsClient`

ImportFlowOperationsClient

public virtual OperationsClient ImportFlowOperationsClient { get; }

The long-running operations client for ImportFlow.

Property Value
Type	Description
`OperationsClient`

TrainFlowOperationsClient

public virtual OperationsClient TrainFlowOperationsClient { get; }

The long-running operations client for TrainFlow.

Property Value
Type	Description
`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`	`CancellationToken` The CancellationToken to use while creating the client.

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

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

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Flow flow = new Flow();
// Make the request
Flow response = flowsClient.CreateFlow(parent, flow);

CreateFlow(CreateFlowRequest, CallSettings)

public virtual 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.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
CreateFlowRequest request = new CreateFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Flow = new Flow(),
    LanguageCode = "",
};
// Make the request
Flow response = flowsClient.CreateFlow(request);

CreateFlow(String, Flow, CallSettings)

public virtual Flow CreateFlow(string parent, Flow flow, 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
`parent`	`String` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Flow flow = new Flow();
// Make the request
Flow response = flowsClient.CreateFlow(parent, flow);

CreateFlowAsync(AgentName, Flow, CallSettings)

public virtual Task<Flow> CreateFlowAsync(AgentName parent, Flow flow, 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
`parent`	`AgentName` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Flow flow = new Flow();
// Make the request
Flow response = await flowsClient.CreateFlowAsync(parent, flow);

CreateFlowAsync(AgentName, Flow, CancellationToken)

public virtual Task<Flow> CreateFlowAsync(AgentName parent, Flow flow, CancellationToken cancellationToken)

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
`parent`	`AgentName` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Flow flow = new Flow();
// Make the request
Flow response = await flowsClient.CreateFlowAsync(parent, flow);

CreateFlowAsync(CreateFlowRequest, CallSettings)

public virtual 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
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
CreateFlowRequest request = new CreateFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Flow = new Flow(),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.CreateFlowAsync(request);

CreateFlowAsync(CreateFlowRequest, CancellationToken)

public virtual Task<Flow> CreateFlowAsync(CreateFlowRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
CreateFlowRequest request = new CreateFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Flow = new Flow(),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.CreateFlowAsync(request);

CreateFlowAsync(String, Flow, CallSettings)

public virtual Task<Flow> CreateFlowAsync(string parent, Flow flow, 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
`parent`	`String` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Flow flow = new Flow();
// Make the request
Flow response = await flowsClient.CreateFlowAsync(parent, flow);

CreateFlowAsync(String, Flow, CancellationToken)

public virtual Task<Flow> CreateFlowAsync(string parent, Flow flow, CancellationToken cancellationToken)

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
`parent`	`String` Required. The agent to create a flow for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`flow`	`Flow` Required. The flow to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Flow flow = new Flow();
// Make the request
Flow response = await flowsClient.CreateFlowAsync(parent, flow);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
DeleteFlowRequest request = new DeleteFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    Force = false,
};
// Make the request
flowsClient.DeleteFlow(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
flowsClient.DeleteFlow(name);

DeleteFlow(String, CallSettings)

public virtual void DeleteFlow(string name, CallSettings callSettings = null)

Deletes a specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
flowsClient.DeleteFlow(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
DeleteFlowRequest request = new DeleteFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    Force = false,
};
// Make the request
await flowsClient.DeleteFlowAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
DeleteFlowRequest request = new DeleteFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    Force = false,
};
// Make the request
await flowsClient.DeleteFlowAsync(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
await flowsClient.DeleteFlowAsync(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
await flowsClient.DeleteFlowAsync(name);

DeleteFlowAsync(String, CallSettings)

public virtual Task DeleteFlowAsync(string name, CallSettings callSettings = null)

Deletes a specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
await flowsClient.DeleteFlowAsync(name);

DeleteFlowAsync(String, CancellationToken)

public virtual Task DeleteFlowAsync(string name, CancellationToken cancellationToken)

Deletes a specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
await flowsClient.DeleteFlowAsync(name);

ExportFlow(ExportFlowRequest, CallSettings)

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

Exports the specified flow to a binary file.

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
`Operation<ExportFlowResponse, Struct>`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
ExportFlowRequest request = new ExportFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    FlowUri = "",
    IncludeReferencedFlows = false,
};
// Make the request
Operation<ExportFlowResponse, Struct> response = flowsClient.ExportFlow(request);

// Poll until the returned long-running operation is complete
Operation<ExportFlowResponse, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportFlowResponse, Struct> retrievedResponse = flowsClient.PollOnceExportFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportFlowResponse retrievedResult = retrievedResponse.Result;
}

ExportFlowAsync(ExportFlowRequest, CallSettings)

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

Exports the specified flow to a binary file.

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
`Task<Operation<ExportFlowResponse, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ExportFlowRequest request = new ExportFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    FlowUri = "",
    IncludeReferencedFlows = false,
};
// Make the request
Operation<ExportFlowResponse, Struct> response = await flowsClient.ExportFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportFlowResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportFlowResponse, Struct> retrievedResponse = await flowsClient.PollOnceExportFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportFlowResponse retrievedResult = retrievedResponse.Result;
}

ExportFlowAsync(ExportFlowRequest, CancellationToken)

public virtual Task<Operation<ExportFlowResponse, Struct>> ExportFlowAsync(ExportFlowRequest request, CancellationToken cancellationToken)

Exports the specified flow to a binary file.

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ExportFlowResponse, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ExportFlowRequest request = new ExportFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    FlowUri = "",
    IncludeReferencedFlows = false,
};
// Make the request
Operation<ExportFlowResponse, Struct> response = await flowsClient.ExportFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportFlowResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportFlowResponse, Struct> retrievedResponse = await flowsClient.PollOnceExportFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportFlowResponse retrievedResult = retrievedResponse.Result;
}

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Flow response = flowsClient.GetFlow(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
GetFlowRequest request = new GetFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
Flow response = flowsClient.GetFlow(request);

GetFlow(String, CallSettings)

public virtual Flow GetFlow(string name, CallSettings callSettings = null)

Retrieves the specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to get. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Flow response = flowsClient.GetFlow(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Flow response = await flowsClient.GetFlowAsync(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Flow response = await flowsClient.GetFlowAsync(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
GetFlowRequest request = new GetFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.GetFlowAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
GetFlowRequest request = new GetFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.GetFlowAsync(request);

GetFlowAsync(String, CallSettings)

public virtual Task<Flow> GetFlowAsync(string name, CallSettings callSettings = null)

Retrieves the specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to get. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Flow response = await flowsClient.GetFlowAsync(name);

GetFlowAsync(String, CancellationToken)

public virtual Task<Flow> GetFlowAsync(string name, CancellationToken cancellationToken)

Retrieves the specified flow.

Parameters
Name	Description
`name`	`String` Required. The name of the flow to get. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Flow response = await flowsClient.GetFlowAsync(name);

GetFlowValidationResult(FlowValidationResultName, CallSettings)

public virtual FlowValidationResult GetFlowValidationResult(FlowValidationResultName name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`FlowValidationResultName` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`FlowValidationResult`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
FlowValidationResultName name = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
FlowValidationResult response = flowsClient.GetFlowValidationResult(name);

GetFlowValidationResult(GetFlowValidationResultRequest, CallSettings)

public virtual 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.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
GetFlowValidationResultRequest request = new GetFlowValidationResultRequest
{
    FlowValidationResultName = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = flowsClient.GetFlowValidationResult(request);

GetFlowValidationResult(String, CallSettings)

public virtual FlowValidationResult GetFlowValidationResult(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`String` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`FlowValidationResult`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]/validationResult";
// Make the request
FlowValidationResult response = flowsClient.GetFlowValidationResult(name);

GetFlowValidationResultAsync(FlowValidationResultName, CallSettings)

public virtual Task<FlowValidationResult> GetFlowValidationResultAsync(FlowValidationResultName name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`FlowValidationResultName` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowValidationResultName name = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(name);

GetFlowValidationResultAsync(FlowValidationResultName, CancellationToken)

public virtual Task<FlowValidationResult> GetFlowValidationResultAsync(FlowValidationResultName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
`name`	`FlowValidationResultName` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowValidationResultName name = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(name);

GetFlowValidationResultAsync(GetFlowValidationResultRequest, CallSettings)

public virtual 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
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
GetFlowValidationResultRequest request = new GetFlowValidationResultRequest
{
    FlowValidationResultName = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(request);

GetFlowValidationResultAsync(GetFlowValidationResultRequest, CancellationToken)

public virtual Task<FlowValidationResult> GetFlowValidationResultAsync(GetFlowValidationResultRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
GetFlowValidationResultRequest request = new GetFlowValidationResultRequest
{
    FlowValidationResultName = FlowValidationResultName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(request);

GetFlowValidationResultAsync(String, CallSettings)

public virtual Task<FlowValidationResult> GetFlowValidationResultAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`String` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]/validationResult";
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(name);

GetFlowValidationResultAsync(String, CancellationToken)

public virtual Task<FlowValidationResult> GetFlowValidationResultAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
`name`	`String` Required. The flow name. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/validationResult`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]/validationResult";
// Make the request
FlowValidationResult response = await flowsClient.GetFlowValidationResultAsync(name);

ImportFlow(ImportFlowRequest, CallSettings)

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

Imports the specified flow to the specified agent from a binary file.

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
`Operation<ImportFlowResponse, Struct>`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
ImportFlowRequest request = new ImportFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    FlowUri = "",
    ImportOption = ImportFlowRequest.Types.ImportOption.Unspecified,
};
// Make the request
Operation<ImportFlowResponse, Struct> response = flowsClient.ImportFlow(request);

// Poll until the returned long-running operation is complete
Operation<ImportFlowResponse, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportFlowResponse, Struct> retrievedResponse = flowsClient.PollOnceImportFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportFlowResponse retrievedResult = retrievedResponse.Result;
}

ImportFlowAsync(ImportFlowRequest, CallSettings)

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

Imports the specified flow to the specified agent from a binary file.

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
`Task<Operation<ImportFlowResponse, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ImportFlowRequest request = new ImportFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    FlowUri = "",
    ImportOption = ImportFlowRequest.Types.ImportOption.Unspecified,
};
// Make the request
Operation<ImportFlowResponse, Struct> response = await flowsClient.ImportFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportFlowResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportFlowResponse, Struct> retrievedResponse = await flowsClient.PollOnceImportFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportFlowResponse retrievedResult = retrievedResponse.Result;
}

ImportFlowAsync(ImportFlowRequest, CancellationToken)

public virtual Task<Operation<ImportFlowResponse, Struct>> ImportFlowAsync(ImportFlowRequest request, CancellationToken cancellationToken)

Imports the specified flow to the specified agent from a binary file.

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ImportFlowResponse, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ImportFlowRequest request = new ImportFlowRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    FlowUri = "",
    ImportOption = ImportFlowRequest.Types.ImportOption.Unspecified,
};
// Make the request
Operation<ImportFlowResponse, Struct> response = await flowsClient.ImportFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportFlowResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportFlowResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportFlowResponse, Struct> retrievedResponse = await flowsClient.PollOnceImportFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportFlowResponse retrievedResult = retrievedResponse.Result;
}

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListFlowsResponse, Flow>`	A pageable sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlows(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Flow item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFlowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListFlowsResponse, Flow>`	A pageable sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
ListFlowsRequest request = new ListFlowsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlows(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Flow item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFlowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`String` Required. The agent containing the flows. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListFlowsResponse, Flow>`	A pageable sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlows(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Flow item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFlowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListFlowsResponse, Flow>`	A pageable asynchronous sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlowsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Flow item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFlowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListFlowsResponse, Flow>`	A pageable asynchronous sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ListFlowsRequest request = new ListFlowsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlowsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Flow item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFlowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`String` Required. The agent containing the flows. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListFlowsResponse, Flow>`	A pageable asynchronous sequence of Flow resources.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<ListFlowsResponse, Flow> response = flowsClient.ListFlowsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Flow item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFlowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Flow item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Flow> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Flow item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceExportFlow(String, CallSettings)

public virtual Operation<ExportFlowResponse, Struct> PollOnceExportFlow(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportFlow.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ExportFlowResponse, Struct>`	The result of polling the operation.

PollOnceExportFlowAsync(String, CallSettings)

public virtual Task<Operation<ExportFlowResponse, Struct>> PollOnceExportFlowAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportFlow.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ExportFlowResponse, Struct>>`	A task representing the result of polling the operation.

PollOnceImportFlow(String, CallSettings)

public virtual Operation<ImportFlowResponse, Struct> PollOnceImportFlow(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportFlow.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ImportFlowResponse, Struct>`	The result of polling the operation.

PollOnceImportFlowAsync(String, CallSettings)

public virtual Task<Operation<ImportFlowResponse, Struct>> PollOnceImportFlowAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportFlow.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ImportFlowResponse, Struct>>`	A task representing the result of polling the operation.

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`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, 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`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, 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
`Task`	A task representing the asynchronous shutdown operation.

Remarks

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.

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

Parameters
Name	Description
`name`	`FlowName` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, Struct>`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Operation<Empty, Struct> response = flowsClient.TrainFlow(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = flowsClient.PollOnceTrainFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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
`Operation<Empty, Struct>`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
TrainFlowRequest request = new TrainFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
};
// Make the request
Operation<Empty, Struct> response = flowsClient.TrainFlow(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = flowsClient.PollOnceTrainFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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

Parameters
Name	Description
`name`	`String` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, Struct>`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Operation<Empty, Struct> response = flowsClient.TrainFlow(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = flowsClient.PollOnceTrainFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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

Parameters
Name	Description
`name`	`FlowName` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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

Parameters
Name	Description
`name`	`FlowName` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
FlowName name = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
TrainFlowRequest request = new TrainFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
};
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
TrainFlowRequest request = new TrainFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
};
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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

Parameters
Name	Description
`name`	`String` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

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.

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

Parameters
Name	Description
`name`	`String` Required. The flow to train. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<Empty, Struct>>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/flows/[FLOW]";
// Make the request
Operation<Empty, Struct> response = await flowsClient.TrainFlowAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await flowsClient.PollOnceTrainFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

UpdateFlow(Flow, FieldMask, CallSettings)

public virtual Flow UpdateFlow(Flow flow, FieldMask updateMask, 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
`flow`	`Flow` Required. The flow to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Flow`	The RPC response.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
Flow flow = new Flow();
FieldMask updateMask = new FieldMask();
// Make the request
Flow response = flowsClient.UpdateFlow(flow, updateMask);

UpdateFlow(UpdateFlowRequest, CallSettings)

public virtual 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.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
UpdateFlowRequest request = new UpdateFlowRequest
{
    Flow = new Flow(),
    UpdateMask = new FieldMask(),
    LanguageCode = "",
};
// Make the request
Flow response = flowsClient.UpdateFlow(request);

UpdateFlowAsync(Flow, FieldMask, CallSettings)

public virtual Task<Flow> UpdateFlowAsync(Flow flow, FieldMask updateMask, 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
`flow`	`Flow` Required. The flow to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
Flow flow = new Flow();
FieldMask updateMask = new FieldMask();
// Make the request
Flow response = await flowsClient.UpdateFlowAsync(flow, updateMask);

UpdateFlowAsync(Flow, FieldMask, CancellationToken)

public virtual Task<Flow> UpdateFlowAsync(Flow flow, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified flow.

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

Parameters
Name	Description
`flow`	`Flow` Required. The flow to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
Flow flow = new Flow();
FieldMask updateMask = new FieldMask();
// Make the request
Flow response = await flowsClient.UpdateFlowAsync(flow, updateMask);

UpdateFlowAsync(UpdateFlowRequest, CallSettings)

public virtual 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
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
UpdateFlowRequest request = new UpdateFlowRequest
{
    Flow = new Flow(),
    UpdateMask = new FieldMask(),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.UpdateFlowAsync(request);

UpdateFlowAsync(UpdateFlowRequest, CancellationToken)

public virtual Task<Flow> UpdateFlowAsync(UpdateFlowRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Flow>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
UpdateFlowRequest request = new UpdateFlowRequest
{
    Flow = new Flow(),
    UpdateMask = new FieldMask(),
    LanguageCode = "",
};
// Make the request
Flow response = await flowsClient.UpdateFlowAsync(request);

ValidateFlow(ValidateFlowRequest, CallSettings)

public virtual 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.

Example

// Create client
FlowsClient flowsClient = FlowsClient.Create();
// Initialize request argument(s)
ValidateFlowRequest request = new ValidateFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = flowsClient.ValidateFlow(request);

ValidateFlowAsync(ValidateFlowRequest, CallSettings)

public virtual 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
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ValidateFlowRequest request = new ValidateFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = await flowsClient.ValidateFlowAsync(request);

ValidateFlowAsync(ValidateFlowRequest, CancellationToken)

public virtual Task<FlowValidationResult> ValidateFlowAsync(ValidateFlowRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<FlowValidationResult>`	A Task containing the RPC response.

Example

// Create client
FlowsClient flowsClient = await FlowsClient.CreateAsync();
// Initialize request argument(s)
ValidateFlowRequest request = new ValidateFlowRequest
{
    FlowName = FlowName.FromProjectLocationAgentFlow("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]"),
    LanguageCode = "",
};
// Make the request
FlowValidationResult response = await flowsClient.ValidateFlowAsync(request);