public class Environments.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 > ClientBaseEnvironmentsEnvironmentsClient > Environments.EnvironmentsClientNamespace
GoogleCloudGoogle.Cloud.DialogflowV2Assembly
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 | CallInvokerThe callInvoker to use to make remote calls. |
EnvironmentsClient(ChannelBase)
public EnvironmentsClient(ChannelBase channel)Creates a new client for Environments
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
EnvironmentsClient(ClientBaseConfiguration)
protected EnvironmentsClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallOptions)
public virtual Environment CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)Creates an agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | CreateEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Environment | The response received from the server. |
CreateEnvironment(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Environment CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | CreateEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | CreateEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | The call object. |
CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Environment> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | CreateEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | 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 |
LocationsLocationsClient | 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 | DeleteEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DeleteEnvironment(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | DeleteEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
GetEnvironment(GetEnvironmentRequest, CallOptions)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)Retrieves the specified agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Environment | The response received from the server. |
GetEnvironment(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | GetEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | The call object. |
GetEnvironmentAsync(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified agent environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | 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 | GetEnvironmentHistoryRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentHistory | The response received from the server. |
GetEnvironmentHistory(GetEnvironmentHistoryRequest, Metadata, DateTime?, CancellationToken)
public virtual EnvironmentHistory GetEnvironmentHistory(GetEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the history of the specified environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentHistoryRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | GetEnvironmentHistoryRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironmentHistory | The call object. |
GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<EnvironmentHistory> GetEnvironmentHistoryAsync(GetEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the history of the specified environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentHistoryRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironmentHistory | 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 | ListEnvironmentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListEnvironmentsResponse | The response received from the server. |
ListEnvironments(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns the list of all non-default environments of the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | ListEnvironmentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | ListEnvironmentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListEnvironmentsResponse | The call object. |
ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns the list of all non-default environments of the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | ListEnvironmentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListEnvironmentsResponse | The call object. |
NewInstance(ClientBaseConfiguration)
protected override Environments.EnvironmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
EnvironmentsEnvironmentsClient | |
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 | UpdateEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Environment | The response received from the server. |
UpdateEnvironment(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Environment UpdateEnvironment(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | UpdateEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | UpdateEnvironmentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | The call object. |
UpdateEnvironmentAsync(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Environment> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | UpdateEnvironmentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEnvironment | The call object. |