Dialogflow v3 API - Class Environments.EnvironmentsBase (2.24.0)

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

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

Base class for server-side implementations of Environments

Inheritance

object > Environments.EnvironmentsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Methods

CreateEnvironment(CreateEnvironmentRequest, ServerCallContext)

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

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	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 [Environment][google.cloud.dialogflow.cx.v3.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).

DeployFlow(DeployFlowRequest, ServerCallContext)

public virtual Task<Operation> DeployFlow(DeployFlowRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	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 [Environment][google.cloud.dialogflow.cx.v3.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).

ListContinuousTestResults(ListContinuousTestResultsRequest, ServerCallContext)

public virtual Task<ListContinuousTestResultsResponse> ListContinuousTestResults(ListContinuousTestResultsRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListContinuousTestResultsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListContinuousTestResultsResponse`	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 environments in the specified [Agent][google.cloud.dialogflow.cx.v3.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).

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, ServerCallContext)

public virtual Task<LookupEnvironmentHistoryResponse> LookupEnvironmentHistory(LookupEnvironmentHistoryRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`LookupEnvironmentHistoryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskLookupEnvironmentHistoryResponse`	The response to send back to the client (wrapped by a task).

RunContinuousTest(RunContinuousTestRequest, ServerCallContext)

public virtual Task<Operation> RunContinuousTest(RunContinuousTestRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateEnvironment(UpdateEnvironmentRequest, ServerCallContext)

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

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).