Google Cloud Dialogflow v2 API - Class Environments.EnvironmentsClient (4.6.0)

Version 4.6.0

• 4.25.0 (latest)
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

public class EnvironmentsClient : ClientBase<Environments.EnvironmentsClient>

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

Client for Environments

Inheritance

Object > ClientBase > ClientBase<Environments.EnvironmentsClient> > Environments.EnvironmentsClient

Inherited Members

ClientBase<Environments.EnvironmentsClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

EnvironmentsClient()

protected EnvironmentsClient()

Protected parameterless constructor to allow creation of test doubles.

EnvironmentsClient(CallInvoker)

public EnvironmentsClient(CallInvoker callInvoker)

Creates a new client for Environments that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EnvironmentsClient(ChannelBase)

public EnvironmentsClient(ChannelBase channel)

Creates a new client for Environments

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EnvironmentsClient(ClientBase.ClientBaseConfiguration)

protected EnvironmentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Environment CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Creates an agent environment.

Parameters
Name	Description
request	CreateEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Environment	The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Environment CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an agent environment.

Parameters
Name	Description
request	CreateEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Environment	The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)

Creates an agent environment.

Parameters
Name	Description
request	CreateEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Environment> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an agent environment.

Parameters
Name	Description
request	CreateEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
Locations.LocationsClient	A new Locations.LocationsClient for the same target as this client.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Empty DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Deletes the specified agent environment.

Parameters
Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified agent environment.

Parameters
Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)

Deletes the specified agent environment.

Parameters
Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified agent environment.

Parameters
Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Retrieves the specified agent environment.

Parameters
Name	Description
request	GetEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Environment	The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified agent environment.

Parameters
Name	Description
request	GetEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Environment	The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Retrieves the specified agent environment.

Parameters
Name	Description
request	GetEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified agent environment.

Parameters
Name	Description
request	GetEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.

GetEnvironmentHistory(GetEnvironmentHistoryRequest, CallOptions)

public virtual EnvironmentHistory GetEnvironmentHistory(GetEnvironmentHistoryRequest request, CallOptions options)

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EnvironmentHistory	The response received from the server.

GetEnvironmentHistory(GetEnvironmentHistoryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual EnvironmentHistory GetEnvironmentHistory(GetEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EnvironmentHistory	The response received from the server.

GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, CallOptions)

public virtual AsyncUnaryCall<EnvironmentHistory> GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest request, CallOptions options)

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<EnvironmentHistory>	The call object.

GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<EnvironmentHistory> GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the history of the specified environment.

Parameters
Name	Description
request	GetEnvironmentHistoryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<EnvironmentHistory>	The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEnvironmentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEnvironmentsResponse	The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
request	ListEnvironmentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEnvironmentsResponse	The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEnvironmentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListEnvironmentsResponse>	The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
request	ListEnvironmentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<ListEnvironmentsResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Environments.EnvironmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
Environments.EnvironmentsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.V2.Environments.EnvironmentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)

public virtual Environment UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Environment	The response received from the server.

UpdateEnvironment(UpdateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Environment UpdateEnvironment(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Environment	The response received from the server.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Environment> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Environment>	The call object.