Dialogflow v3 API - Class EnvironmentsClientImpl (2.12.0)

public sealed class EnvironmentsClientImpl : EnvironmentsClient

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

Environments client wrapper implementation, for convenient use.

Inheritance

object > EnvironmentsClient > EnvironmentsClientImpl

Inherited Members

EnvironmentsClient.DefaultEndpoint

EnvironmentsClient.DefaultScopes

EnvironmentsClient.ServiceMetadata

EnvironmentsClient.CreateAsync(CancellationToken)

EnvironmentsClient.Create()

EnvironmentsClient.ShutdownDefaultChannelsAsync()

EnvironmentsClient.ListEnvironments(string, string, int?, CallSettings)

EnvironmentsClient.ListEnvironmentsAsync(string, string, int?, CallSettings)

EnvironmentsClient.ListEnvironments(AgentName, string, int?, CallSettings)

EnvironmentsClient.ListEnvironmentsAsync(AgentName, string, int?, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

EnvironmentsClient.GetEnvironment(string, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(string, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(string, CancellationToken)

EnvironmentsClient.GetEnvironment(EnvironmentName, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(EnvironmentName, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(EnvironmentName, CancellationToken)

EnvironmentsClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

EnvironmentsClient.PollOnceCreateEnvironment(string, CallSettings)

EnvironmentsClient.PollOnceCreateEnvironmentAsync(string, CallSettings)

EnvironmentsClient.CreateEnvironment(string, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(string, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(string, Environment, CancellationToken)

EnvironmentsClient.CreateEnvironment(AgentName, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(AgentName, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(AgentName, Environment, CancellationToken)

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

EnvironmentsClient.PollOnceUpdateEnvironment(string, CallSettings)

EnvironmentsClient.PollOnceUpdateEnvironmentAsync(string, CallSettings)

EnvironmentsClient.UpdateEnvironment(Environment, FieldMask, CallSettings)

EnvironmentsClient.UpdateEnvironmentAsync(Environment, FieldMask, CallSettings)

EnvironmentsClient.UpdateEnvironmentAsync(Environment, FieldMask, CancellationToken)

EnvironmentsClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

EnvironmentsClient.DeleteEnvironment(string, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(string, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(string, CancellationToken)

EnvironmentsClient.DeleteEnvironment(EnvironmentName, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(EnvironmentName, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(EnvironmentName, CancellationToken)

EnvironmentsClient.LookupEnvironmentHistory(string, string, int?, CallSettings)

EnvironmentsClient.LookupEnvironmentHistoryAsync(string, string, int?, CallSettings)

EnvironmentsClient.LookupEnvironmentHistory(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.LookupEnvironmentHistoryAsync(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.RunContinuousTestAsync(RunContinuousTestRequest, CancellationToken)

EnvironmentsClient.PollOnceRunContinuousTest(string, CallSettings)

EnvironmentsClient.PollOnceRunContinuousTestAsync(string, CallSettings)

EnvironmentsClient.ListContinuousTestResults(string, string, int?, CallSettings)

EnvironmentsClient.ListContinuousTestResultsAsync(string, string, int?, CallSettings)

EnvironmentsClient.ListContinuousTestResults(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.ListContinuousTestResultsAsync(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.DeployFlowAsync(DeployFlowRequest, CancellationToken)

EnvironmentsClient.PollOnceDeployFlow(string, CallSettings)

EnvironmentsClient.PollOnceDeployFlowAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

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

Constructors

EnvironmentsClientImpl(EnvironmentsClient, EnvironmentsSettings, ILogger)

public EnvironmentsClientImpl(Environments.EnvironmentsClient grpcClient, EnvironmentsSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`EnvironmentsEnvironmentsClient` The underlying gRPC client.
`settings`	`EnvironmentsSettings` The base EnvironmentsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.CreateEnvironmentOperationsClient

DeployFlowOperationsClient

public override OperationsClient DeployFlowOperationsClient { get; }

The long-running operations client for DeployFlow.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.DeployFlowOperationsClient

GrpcClient

public override Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
Type	Description
`EnvironmentsEnvironmentsClient`

Overrides

EnvironmentsClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

EnvironmentsClient.LocationsClient

RunContinuousTestOperationsClient

public override OperationsClient RunContinuousTestOperationsClient { get; }

The long-running operations client for RunContinuousTest.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.RunContinuousTestOperationsClient

UpdateEnvironmentOperationsClient

public override OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.UpdateEnvironmentOperationsClient

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.CreateEnvironment(CreateEnvironmentRequest, CallSettings)

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

DeployFlow(DeployFlowRequest, CallSettings)

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

Overrides

EnvironmentsClient.DeployFlow(DeployFlowRequest, CallSettings)

DeployFlowAsync(DeployFlowRequest, CallSettings)

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

Overrides

EnvironmentsClient.DeployFlowAsync(DeployFlowRequest, CallSettings)

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.GetEnvironment(GetEnvironmentRequest, CallSettings)

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

ListContinuousTestResults(ListContinuousTestResultsRequest, CallSettings)

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

Overrides

EnvironmentsClient.ListContinuousTestResults(ListContinuousTestResultsRequest, CallSettings)

ListContinuousTestResultsAsync(ListContinuousTestResultsRequest, CallSettings)

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

Overrides

EnvironmentsClient.ListContinuousTestResultsAsync(ListContinuousTestResultsRequest, CallSettings)

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Overrides

EnvironmentsClient.ListEnvironments(ListEnvironmentsRequest, CallSettings)

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Overrides

EnvironmentsClient.ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, CallSettings)

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

Overrides

EnvironmentsClient.LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, CallSettings)

LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, CallSettings)

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

Overrides

EnvironmentsClient.LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, CallSettings)

RunContinuousTest(RunContinuousTestRequest, CallSettings)

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

Overrides

EnvironmentsClient.RunContinuousTest(RunContinuousTestRequest, CallSettings)

RunContinuousTestAsync(RunContinuousTestRequest, CallSettings)

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

Overrides

EnvironmentsClient.RunContinuousTestAsync(RunContinuousTestRequest, CallSettings)

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

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

Overrides

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)