Google Cloud Dialogflow v2 API - Class EnvironmentsClientImpl (4.9.0) 

public sealed class EnvironmentsClientImpl : EnvironmentsClient

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class EnvironmentsClientImpl.

Environments client wrapper implementation, for convenient use.

Inheritance

object > EnvironmentsClient > EnvironmentsClientImpl

Namespace

GoogleCloudGoogle.Cloud.DialogflowV2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Service for managing [Environments][google.cloud.dialogflow.v2.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
NameDescription
grpcClientEnvironmentsEnvironmentsClient

The underlying gRPC client.

settingsEnvironmentsSettings

The base EnvironmentsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
TypeDescription
EnvironmentsEnvironmentsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public override Environment CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an agent environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Environment

The RPC response.

Overrides

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override Task<Environment> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an agent environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEnvironment

A Task containing the RPC response.

Overrides

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Deletes the specified agent environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Deletes the specified agent environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Retrieves the specified agent environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Environment

The RPC response.

Overrides

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Retrieves the specified agent environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEnvironment

A Task containing the RPC response.

Overrides

GetEnvironmentHistory(GetEnvironmentHistoryRequest, CallSettings)

public override PagedEnumerable<EnvironmentHistory, EnvironmentHistory.Types.Entry> GetEnvironmentHistory(GetEnvironmentHistoryRequest request, CallSettings callSettings = null)

Gets the history of the specified environment.

Parameters
NameDescription
requestGetEnvironmentHistoryRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableEnvironmentHistoryEnvironmentHistoryTypesEntry

A pageable sequence of EnvironmentHistory.Types.Entry resources.

Overrides

GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, CallSettings)

public override PagedAsyncEnumerable<EnvironmentHistory, EnvironmentHistory.Types.Entry> GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest request, CallSettings callSettings = null)

Gets the history of the specified environment.

Parameters
NameDescription
requestGetEnvironmentHistoryRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableEnvironmentHistoryEnvironmentHistoryTypesEntry

A pageable asynchronous sequence of EnvironmentHistory.Types.Entry resources.

Overrides

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Returns the list of all non-default environments of the specified agent.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Overrides

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Returns the list of all non-default environments of the specified agent.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Overrides

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

public override Environment UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters
NameDescription
requestUpdateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Environment

The RPC response.

Overrides

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

public override Task<Environment> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters
NameDescription
requestUpdateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEnvironment

A Task containing the RPC response.

Overrides