Google Cloud Dialogflow v2 API - Class Environments.EnvironmentsBase (4.24.0)

[BindServiceMethod(typeof(Environments), "BindService")]
public abstract class Environments.EnvironmentsBase

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

Base class for server-side implementations of Environments

Inheritance

object > Environments.EnvironmentsBase

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Methods

CreateEnvironment(CreateEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> CreateEnvironment(CreateEnvironmentRequest request, ServerCallContext context)

Creates an agent environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEnvironment

The response to send back to the client (wrapped by a task).

DeleteEnvironment(DeleteEnvironmentRequest, ServerCallContext)

public virtual Task<Empty> DeleteEnvironment(DeleteEnvironmentRequest request, ServerCallContext context)

Deletes the specified agent environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

GetEnvironment(GetEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> GetEnvironment(GetEnvironmentRequest request, ServerCallContext context)

Retrieves the specified agent environment.

Parameters
Name Description
request GetEnvironmentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEnvironment

The response to send back to the client (wrapped by a task).

GetEnvironmentHistory(GetEnvironmentHistoryRequest, ServerCallContext)

public virtual Task<EnvironmentHistory> GetEnvironmentHistory(GetEnvironmentHistoryRequest request, ServerCallContext context)

Gets the history of the specified environment.

Parameters
Name Description
request GetEnvironmentHistoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEnvironmentHistory

The response to send back to the client (wrapped by a task).

ListEnvironments(ListEnvironmentsRequest, ServerCallContext)

public virtual Task<ListEnvironmentsResponse> ListEnvironments(ListEnvironmentsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListEnvironmentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListEnvironmentsResponse

The response to send back to the client (wrapped by a task).

UpdateEnvironment(UpdateEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> UpdateEnvironment(UpdateEnvironmentRequest request, ServerCallContext context)

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
Name Description
request UpdateEnvironmentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEnvironment

The response to send back to the client (wrapped by a task).