Dialogflow v3 API - Class EnvironmentsClient (2.20.0)

public abstract class EnvironmentsClient

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

Environments client wrapper, for convenient use.

Inheritance

object > EnvironmentsClient

Derived Types

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].

Properties

CreateEnvironmentOperationsClient

public virtual OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Environments 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 Environments scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

DeployFlowOperationsClient

public virtual OperationsClient DeployFlowOperationsClient { get; }

The long-running operations client for DeployFlow.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
Type Description
EnvironmentsEnvironmentsClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

RunContinuousTestOperationsClient

public virtual OperationsClient RunContinuousTestOperationsClient { get; }

The long-running operations client for RunContinuousTest.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateEnvironmentOperationsClient

public virtual OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
Type Description
OperationsClient

Methods

Create()

public static EnvironmentsClient Create()

Synchronously creates a EnvironmentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnvironmentsClientBuilder.

Returns
Type Description
EnvironmentsClient

The created EnvironmentsClient.

CreateAsync(CancellationToken)

public static Task<EnvironmentsClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a EnvironmentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnvironmentsClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskEnvironmentsClient

The task representing the created EnvironmentsClient.

CreateEnvironment(AgentName, Environment, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(AgentName parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent AgentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentStruct

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::AgentName parent = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = environmentsClient.CreateEnvironment(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = environmentsClient.PollOnceCreateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request CreateEnvironmentRequest

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
OperationEnvironmentStruct

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::CreateEnvironmentRequest request = new gcdcv::CreateEnvironmentRequest
{
    ParentAsAgentName = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Environment = new gcdcv::Environment(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = environmentsClient.CreateEnvironment(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = environmentsClient.PollOnceCreateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironment(string, Environment, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(string parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent string

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentStruct

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = environmentsClient.CreateEnvironment(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = environmentsClient.PollOnceCreateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(AgentName, Environment, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(AgentName parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent AgentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::AgentName parent = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(AgentName, Environment, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(AgentName parent, Environment environment, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent AgentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::AgentName parent = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request CreateEnvironmentRequest

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
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::CreateEnvironmentRequest request = new gcdcv::CreateEnvironmentRequest
{
    ParentAsAgentName = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Environment = new gcdcv::Environment(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request CreateEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::CreateEnvironmentRequest request = new gcdcv::CreateEnvironmentRequest
{
    ParentAsAgentName = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Environment = new gcdcv::Environment(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(string, Environment, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(string parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent string

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(string, Environment, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(string parent, Environment environment, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
parent string

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

environment Environment

Required. The environment to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
gcdcv::Environment environment = new gcdcv::Environment();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.CreateEnvironmentAsync(parent, environment);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

public virtual void DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request DeleteEnvironmentRequest

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
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::DeleteEnvironmentRequest request = new gcdcv::DeleteEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
environmentsClient.DeleteEnvironment(request);

DeleteEnvironment(EnvironmentName, CallSettings)

public virtual void DeleteEnvironment(EnvironmentName name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
environmentsClient.DeleteEnvironment(name);

DeleteEnvironment(string, CallSettings)

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

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
environmentsClient.DeleteEnvironment(name);

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public virtual Task DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request DeleteEnvironmentRequest

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
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::DeleteEnvironmentRequest request = new gcdcv::DeleteEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
await environmentsClient.DeleteEnvironmentAsync(request);

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

public virtual Task DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request DeleteEnvironmentRequest

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
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::DeleteEnvironmentRequest request = new gcdcv::DeleteEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
await environmentsClient.DeleteEnvironmentAsync(request);

DeleteEnvironmentAsync(EnvironmentName, CallSettings)

public virtual Task DeleteEnvironmentAsync(EnvironmentName name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
await environmentsClient.DeleteEnvironmentAsync(name);

DeleteEnvironmentAsync(EnvironmentName, CancellationToken)

public virtual Task DeleteEnvironmentAsync(EnvironmentName name, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
await environmentsClient.DeleteEnvironmentAsync(name);

DeleteEnvironmentAsync(string, CallSettings)

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

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
await environmentsClient.DeleteEnvironmentAsync(name);

DeleteEnvironmentAsync(string, CancellationToken)

public virtual Task DeleteEnvironmentAsync(string name, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
await environmentsClient.DeleteEnvironmentAsync(name);

DeployFlow(DeployFlowRequest, CallSettings)

public virtual Operation<DeployFlowResponse, DeployFlowMetadata> DeployFlow(DeployFlowRequest request, CallSettings callSettings = null)

Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
  • response: [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse]
Parameters
Name Description
request DeployFlowRequest

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
OperationDeployFlowResponseDeployFlowMetadata

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::DeployFlowRequest request = new gcdcv::DeployFlowRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
    FlowVersionAsVersionName = gcdcv::VersionName.FromProjectLocationAgentFlowVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]"),
};
// Make the request
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> response = environmentsClient.DeployFlow(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::DeployFlowResponse 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<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> retrievedResponse = environmentsClient.PollOnceDeployFlow(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::DeployFlowResponse retrievedResult = retrievedResponse.Result;
}

DeployFlowAsync(DeployFlowRequest, CallSettings)

public virtual Task<Operation<DeployFlowResponse, DeployFlowMetadata>> DeployFlowAsync(DeployFlowRequest request, CallSettings callSettings = null)

Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
  • response: [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse]
Parameters
Name Description
request DeployFlowRequest

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
TaskOperationDeployFlowResponseDeployFlowMetadata

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::DeployFlowRequest request = new gcdcv::DeployFlowRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
    FlowVersionAsVersionName = gcdcv::VersionName.FromProjectLocationAgentFlowVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]"),
};
// Make the request
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> response = await environmentsClient.DeployFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::DeployFlowResponse 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<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> retrievedResponse = await environmentsClient.PollOnceDeployFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::DeployFlowResponse retrievedResult = retrievedResponse.Result;
}

DeployFlowAsync(DeployFlowRequest, CancellationToken)

public virtual Task<Operation<DeployFlowResponse, DeployFlowMetadata>> DeployFlowAsync(DeployFlowRequest request, CancellationToken cancellationToken)

Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
  • response: [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse]
Parameters
Name Description
request DeployFlowRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDeployFlowResponseDeployFlowMetadata

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::DeployFlowRequest request = new gcdcv::DeployFlowRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
    FlowVersionAsVersionName = gcdcv::VersionName.FromProjectLocationAgentFlowVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]"),
};
// Make the request
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> response = await environmentsClient.DeployFlowAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::DeployFlowResponse 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<gcdcv::DeployFlowResponse, gcdcv::DeployFlowMetadata> retrievedResponse = await environmentsClient.PollOnceDeployFlowAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::DeployFlowResponse retrievedResult = retrievedResponse.Result;
}

GetEnvironment(EnvironmentName, CallSettings)

public virtual Environment GetEnvironment(EnvironmentName name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Environment

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
gcdcv::Environment response = environmentsClient.GetEnvironment(name);

GetEnvironment(GetEnvironmentRequest, CallSettings)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request GetEnvironmentRequest

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
Environment

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::GetEnvironmentRequest request = new gcdcv::GetEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
gcdcv::Environment response = environmentsClient.GetEnvironment(request);

GetEnvironment(string, CallSettings)

public virtual Environment GetEnvironment(string name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Environment

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
gcdcv::Environment response = environmentsClient.GetEnvironment(name);

GetEnvironmentAsync(EnvironmentName, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(EnvironmentName name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(name);

GetEnvironmentAsync(EnvironmentName, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(EnvironmentName name, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(name);

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request GetEnvironmentRequest

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
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::GetEnvironmentRequest request = new gcdcv::GetEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(request);

GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request GetEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::GetEnvironmentRequest request = new gcdcv::GetEnvironmentRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(request);

GetEnvironmentAsync(string, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(string name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(name);

GetEnvironmentAsync(string, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(string name, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
gcdcv::Environment response = await environmentsClient.GetEnvironmentAsync(name);

ListContinuousTestResults(EnvironmentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResults(EnvironmentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
parent EnvironmentName

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::EnvironmentName parent = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
PagedEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResults(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::ContinuousTestResult 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 (gcdcv::ListContinuousTestResultsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListContinuousTestResults(ListContinuousTestResultsRequest, CallSettings)

public virtual PagedEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResults(ListContinuousTestResultsRequest request, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
request ListContinuousTestResultsRequest

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
PagedEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::ListContinuousTestResultsRequest request = new gcdcv::ListContinuousTestResultsRequest
{
    ParentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
PagedEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResults(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::ContinuousTestResult 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 (gcdcv::ListContinuousTestResultsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListContinuousTestResults(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResults(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
parent string

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
PagedEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResults(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::ContinuousTestResult 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 (gcdcv::ListContinuousTestResultsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListContinuousTestResultsAsync(EnvironmentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResultsAsync(EnvironmentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
parent EnvironmentName

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable asynchronous sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName parent = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
PagedAsyncEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResultsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::ContinuousTestResult 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((gcdcv::ListContinuousTestResultsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListContinuousTestResultsAsync(ListContinuousTestResultsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResultsAsync(ListContinuousTestResultsRequest request, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
request ListContinuousTestResultsRequest

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
PagedAsyncEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable asynchronous sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::ListContinuousTestResultsRequest request = new gcdcv::ListContinuousTestResultsRequest
{
    ParentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
PagedAsyncEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResultsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::ContinuousTestResult 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((gcdcv::ListContinuousTestResultsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListContinuousTestResultsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListContinuousTestResultsResponse, ContinuousTestResult> ListContinuousTestResultsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
parent string

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListContinuousTestResultsResponseContinuousTestResult

A pageable asynchronous sequence of ContinuousTestResult resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
PagedAsyncEnumerable<gcdcv::ListContinuousTestResultsResponse, gcdcv::ContinuousTestResult> response = environmentsClient.ListContinuousTestResultsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::ContinuousTestResult 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((gcdcv::ListContinuousTestResultsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::ContinuousTestResult 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<gcdcv::ContinuousTestResult> 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 (gcdcv::ContinuousTestResult 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;

ListEnvironments(AgentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
parent AgentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::AgentName parent = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::ListEnvironmentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

ListEnvironments(ListEnvironmentsRequest, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
request ListEnvironmentsRequest

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
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::ListEnvironmentsRequest request = new gcdcv::ListEnvironmentsRequest
{
    ParentAsAgentName = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::ListEnvironmentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

ListEnvironments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
parent string

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::ListEnvironmentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

ListEnvironmentsAsync(AgentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
parent AgentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::AgentName parent = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironmentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::ListEnvironmentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
request ListEnvironmentsRequest

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
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::ListEnvironmentsRequest request = new gcdcv::ListEnvironmentsRequest
{
    ParentAsAgentName = gcdcv::AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedAsyncEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironmentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::ListEnvironmentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

ListEnvironmentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
parent string

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<gcdcv::ListEnvironmentsResponse, gcdcv::Environment> response = environmentsClient.ListEnvironmentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::ListEnvironmentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistory(EnvironmentName, string, int?, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(EnvironmentName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
PagedEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistory(name);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::LookupEnvironmentHistoryResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(LookupEnvironmentHistoryRequest request, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request LookupEnvironmentHistoryRequest

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
PagedEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::LookupEnvironmentHistoryRequest request = new gcdcv::LookupEnvironmentHistoryRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
PagedEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistory(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::LookupEnvironmentHistoryResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistory(string, string, int?, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
PagedEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistory(name);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdcv::Environment 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 (gcdcv::LookupEnvironmentHistoryResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistoryAsync(EnvironmentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(EnvironmentName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name EnvironmentName

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::EnvironmentName name = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
// Make the request
PagedAsyncEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistoryAsync(name);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::LookupEnvironmentHistoryResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest request, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
request LookupEnvironmentHistoryRequest

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
PagedAsyncEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::LookupEnvironmentHistoryRequest request = new gcdcv::LookupEnvironmentHistoryRequest
{
    EnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
PagedAsyncEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistoryAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::LookupEnvironmentHistoryResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

LookupEnvironmentHistoryAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name Description
name string

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableLookupEnvironmentHistoryResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/environments/[ENVIRONMENT]";
// Make the request
PagedAsyncEnumerable<gcdcv::LookupEnvironmentHistoryResponse, gcdcv::Environment> response = environmentsClient.LookupEnvironmentHistoryAsync(name);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdcv::Environment 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((gcdcv::LookupEnvironmentHistoryResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdcv::Environment 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<gcdcv::Environment> 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 (gcdcv::Environment 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;

PollOnceCreateEnvironment(string, CallSettings)

public virtual Operation<Environment, Struct> PollOnceCreateEnvironment(string operationName, CallSettings callSettings = null)

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

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
OperationEnvironmentStruct

The result of polling the operation.

PollOnceCreateEnvironmentAsync(string, CallSettings)

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

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

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
TaskOperationEnvironmentStruct

A task representing the result of polling the operation.

PollOnceDeployFlow(string, CallSettings)

public virtual Operation<DeployFlowResponse, DeployFlowMetadata> PollOnceDeployFlow(string operationName, CallSettings callSettings = null)

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

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
OperationDeployFlowResponseDeployFlowMetadata

The result of polling the operation.

PollOnceDeployFlowAsync(string, CallSettings)

public virtual Task<Operation<DeployFlowResponse, DeployFlowMetadata>> PollOnceDeployFlowAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationDeployFlowResponseDeployFlowMetadata

A task representing the result of polling the operation.

PollOnceRunContinuousTest(string, CallSettings)

public virtual Operation<RunContinuousTestResponse, RunContinuousTestMetadata> PollOnceRunContinuousTest(string operationName, CallSettings callSettings = null)

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

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
OperationRunContinuousTestResponseRunContinuousTestMetadata

The result of polling the operation.

PollOnceRunContinuousTestAsync(string, CallSettings)

public virtual Task<Operation<RunContinuousTestResponse, RunContinuousTestMetadata>> PollOnceRunContinuousTestAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationRunContinuousTestResponseRunContinuousTestMetadata

A task representing the result of polling the operation.

PollOnceUpdateEnvironment(string, CallSettings)

public virtual Operation<Environment, Struct> PollOnceUpdateEnvironment(string operationName, CallSettings callSettings = null)

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

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
OperationEnvironmentStruct

The result of polling the operation.

PollOnceUpdateEnvironmentAsync(string, CallSettings)

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

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

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
TaskOperationEnvironmentStruct

A task representing the result of polling the operation.

RunContinuousTest(RunContinuousTestRequest, CallSettings)

public virtual Operation<RunContinuousTestResponse, RunContinuousTestMetadata> RunContinuousTest(RunContinuousTestRequest request, CallSettings callSettings = null)

Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
  • response: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse]
Parameters
Name Description
request RunContinuousTestRequest

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
OperationRunContinuousTestResponseRunContinuousTestMetadata

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::RunContinuousTestRequest request = new gcdcv::RunContinuousTestRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> response = environmentsClient.RunContinuousTest(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::RunContinuousTestResponse 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<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> retrievedResponse = environmentsClient.PollOnceRunContinuousTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::RunContinuousTestResponse retrievedResult = retrievedResponse.Result;
}

RunContinuousTestAsync(RunContinuousTestRequest, CallSettings)

public virtual Task<Operation<RunContinuousTestResponse, RunContinuousTestMetadata>> RunContinuousTestAsync(RunContinuousTestRequest request, CallSettings callSettings = null)

Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
  • response: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse]
Parameters
Name Description
request RunContinuousTestRequest

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
TaskOperationRunContinuousTestResponseRunContinuousTestMetadata

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::RunContinuousTestRequest request = new gcdcv::RunContinuousTestRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> response = await environmentsClient.RunContinuousTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::RunContinuousTestResponse 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<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> retrievedResponse = await environmentsClient.PollOnceRunContinuousTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::RunContinuousTestResponse retrievedResult = retrievedResponse.Result;
}

RunContinuousTestAsync(RunContinuousTestRequest, CancellationToken)

public virtual Task<Operation<RunContinuousTestResponse, RunContinuousTestMetadata>> RunContinuousTestAsync(RunContinuousTestRequest request, CancellationToken cancellationToken)

Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
  • response: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse]
Parameters
Name Description
request RunContinuousTestRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRunContinuousTestResponseRunContinuousTestMetadata

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::RunContinuousTestRequest request = new gcdcv::RunContinuousTestRequest
{
    EnvironmentAsEnvironmentName = gcdcv::EnvironmentName.FromProjectLocationAgentEnvironment("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"),
};
// Make the request
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> response = await environmentsClient.RunContinuousTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::RunContinuousTestResponse 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<gcdcv::RunContinuousTestResponse, gcdcv::RunContinuousTestMetadata> retrievedResponse = await environmentsClient.PollOnceRunContinuousTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::RunContinuousTestResponse retrievedResult = retrievedResponse.Result;
}

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.

UpdateEnvironment(Environment, FieldMask, CallSettings)

public virtual Operation<Environment, Struct> UpdateEnvironment(Environment environment, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
environment Environment

Required. The environment to update.

updateMask FieldMask

Required. The mask to control which fields get updated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentStruct

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::Environment environment = new gcdcv::Environment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdcv::Environment, Struct> response = environmentsClient.UpdateEnvironment(environment, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = environmentsClient.PollOnceUpdateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

public virtual Operation<Environment, Struct> UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request UpdateEnvironmentRequest

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
OperationEnvironmentStruct

The RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = gcdcv::EnvironmentsClient.Create();
// Initialize request argument(s)
gcdcv::UpdateEnvironmentRequest request = new gcdcv::UpdateEnvironmentRequest
{
    Environment = new gcdcv::Environment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = environmentsClient.UpdateEnvironment(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = environmentsClient.PollOnceUpdateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

UpdateEnvironmentAsync(Environment, FieldMask, CallSettings)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(Environment environment, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
environment Environment

Required. The environment to update.

updateMask FieldMask

Required. The mask to control which fields get updated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::Environment environment = new gcdcv::Environment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.UpdateEnvironmentAsync(environment, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceUpdateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

UpdateEnvironmentAsync(Environment, FieldMask, CancellationToken)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(Environment environment, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
environment Environment

Required. The environment to update.

updateMask FieldMask

Required. The mask to control which fields get updated.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::Environment environment = new gcdcv::Environment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.UpdateEnvironmentAsync(environment, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceUpdateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request UpdateEnvironmentRequest

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
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::UpdateEnvironmentRequest request = new gcdcv::UpdateEnvironmentRequest
{
    Environment = new gcdcv::Environment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.UpdateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceUpdateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CancellationToken cancellationToken)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [Environment][google.cloud.dialogflow.cx.v3.Environment]
Parameters
Name Description
request UpdateEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentStruct

A Task containing the RPC response.

Example
// Create client
gcdcv::EnvironmentsClient environmentsClient = await gcdcv::EnvironmentsClient.CreateAsync();
// Initialize request argument(s)
gcdcv::UpdateEnvironmentRequest request = new gcdcv::UpdateEnvironmentRequest
{
    Environment = new gcdcv::Environment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdcv::Environment, Struct> response = await environmentsClient.UpdateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdcv::Environment, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdcv::Environment 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<gcdcv::Environment, Struct> retrievedResponse = await environmentsClient.PollOnceUpdateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdcv::Environment retrievedResult = retrievedResponse.Result;
}