Google Cloud Dialogflow v2beta1 API - Class EnvironmentsClientImpl (1.0.0-beta12)

Version 1.0.0-beta12

• 1.0.0-beta20 (latest)
• 1.0.0-beta19

public sealed class EnvironmentsClientImpl : EnvironmentsClient

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 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.CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

EnvironmentsClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Remarks

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

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

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Creates an agent 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
Environment	The RPC response.

Overrides

EnvironmentsClient.CreateEnvironment(CreateEnvironmentRequest, CallSettings)

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Creates an agent 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
TaskEnvironment	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 agent 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 agent 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)

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Retrieves the specified agent 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 agent 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)

GetEnvironmentHistory(GetEnvironmentHistoryRequest, CallSettings)

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

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest 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
PagedEnumerableEnvironmentHistoryEnvironmentHistoryTypesEntry	A pageable sequence of EnvironmentHistory.Types.Entry resources.

Overrides

EnvironmentsClient.GetEnvironmentHistory(GetEnvironmentHistoryRequest, CallSettings)

GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, CallSettings)

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

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest 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
PagedAsyncEnumerableEnvironmentHistoryEnvironmentHistoryTypesEntry	A pageable asynchronous sequence of EnvironmentHistory.Types.Entry resources.

Overrides

EnvironmentsClient.GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, CallSettings)

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Returns the list of all non-draft environments of the specified 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 non-draft environments of the specified 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)

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 keeps on 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 version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

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
Environment	The RPC response.

Overrides

EnvironmentsClient.UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

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 keeps on 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 version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

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
TaskEnvironment	A Task containing the RPC response.

Overrides

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)