Class EnvironmentsClient (1.0.0)

Version 1.0.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class EnvironmentsClient

Environments client wrapper, for convenient use.

Inheritance

System.Object > EnvironmentsClient

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Derived Types

EnvironmentsClientImpl

EnvironmentsClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].

Properties

CreateEnvironmentOperationsClient

public virtual OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type	Description
Google.LongRunning.OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Environments service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
Type	Description
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Environments scopes.

Property Value
Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

Remarks

The default Environments scopes are:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dialogflow

GrpcClient

public virtual Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
Type	Description
Environments.EnvironmentsClient

UpdateEnvironmentOperationsClient

public virtual OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Methods

Create()

public static EnvironmentsClient Create()

Synchronously creates a EnvironmentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnvironmentsClientBuilder.

Returns
Type	Description
EnvironmentsClient	The created EnvironmentsClient.

CreateAsync(CancellationToken)

public static Task<EnvironmentsClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a EnvironmentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnvironmentsClientBuilder.

Parameter
Name	Description
cancellationToken	System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client.

Returns
Type	Description
System.Threading.Tasks.Task<EnvironmentsClient>	The task representing the created EnvironmentsClient.

CreateEnvironment(AgentName, Environment, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(AgentName parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	AgentName Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The RPC response.

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
request	CreateEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The RPC response.

CreateEnvironment(String, Environment, CallSettings)

public virtual Operation<Environment, Struct> CreateEnvironment(string parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	System.String Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The RPC response.

CreateEnvironmentAsync(AgentName, Environment, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(AgentName parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	AgentName Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

CreateEnvironmentAsync(AgentName, Environment, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(AgentName parent, Environment environment, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	AgentName Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
request	CreateEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
request	CreateEnvironmentRequest The request object containing all of the parameters for the API call.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

CreateEnvironmentAsync(String, Environment, CallSettings)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(string parent, Environment environment, CallSettings callSettings = null)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	System.String Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

CreateEnvironmentAsync(String, Environment, CancellationToken)

public virtual Task<Operation<Environment, Struct>> CreateEnvironmentAsync(string parent, Environment environment, CancellationToken cancellationToken)

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	System.String Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environment	Environment Required. The environment to create.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

public virtual void DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	DeleteEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteEnvironment(EnvironmentName, CallSettings)

public virtual void DeleteEnvironment(EnvironmentName name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteEnvironment(String, CallSettings)

public virtual void DeleteEnvironment(string name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public virtual Task DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	DeleteEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

public virtual Task DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	DeleteEnvironmentRequest The request object containing all of the parameters for the API call.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteEnvironmentAsync(EnvironmentName, CallSettings)

public virtual Task DeleteEnvironmentAsync(EnvironmentName name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteEnvironmentAsync(EnvironmentName, CancellationToken)

public virtual Task DeleteEnvironmentAsync(EnvironmentName name, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteEnvironmentAsync(String, CallSettings)

public virtual Task DeleteEnvironmentAsync(string name, CallSettings callSettings = null)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteEnvironmentAsync(String, CancellationToken)

public virtual Task DeleteEnvironmentAsync(string name, CancellationToken cancellationToken)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

GetEnvironment(EnvironmentName, CallSettings)

public virtual Environment GetEnvironment(EnvironmentName name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Environment	The RPC response.

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	GetEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Environment	The RPC response.

GetEnvironment(String, CallSettings)

public virtual Environment GetEnvironment(string name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Environment	The RPC response.

GetEnvironmentAsync(EnvironmentName, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(EnvironmentName name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

GetEnvironmentAsync(EnvironmentName, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(EnvironmentName name, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	EnvironmentName Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	GetEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	GetEnvironmentRequest The request object containing all of the parameters for the API call.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

GetEnvironmentAsync(String, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(string name, CallSettings callSettings = null)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

GetEnvironmentAsync(String, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(string name, CancellationToken cancellationToken)

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
name	System.String Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Environment>	A Task containing the RPC response.

ListEnvironments(AgentName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	AgentName Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<ListEnvironmentsResponse, Environment>	A pageable sequence of Environment resources.

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
request	ListEnvironmentsRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<ListEnvironmentsResponse, Environment>	A pageable sequence of Environment resources.

ListEnvironments(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	System.String Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<ListEnvironmentsResponse, Environment>	A pageable sequence of Environment resources.

ListEnvironmentsAsync(AgentName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	AgentName Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>	A pageable asynchronous sequence of Environment resources.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
request	ListEnvironmentsRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>	A pageable asynchronous sequence of Environment resources.

ListEnvironmentsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name	Description
parent	System.String Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>	A pageable asynchronous sequence of Environment resources.

LookupEnvironmentHistory(EnvironmentName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(EnvironmentName name, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
name	EnvironmentName Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable sequence of Environment resources.

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(LookupEnvironmentHistoryRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupEnvironmentHistoryRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable sequence of Environment resources.

LookupEnvironmentHistory(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistory(string name, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable sequence of Environment resources.

LookupEnvironmentHistoryAsync(EnvironmentName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(EnvironmentName name, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
name	EnvironmentName Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable asynchronous sequence of Environment resources.

LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupEnvironmentHistoryRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable asynchronous sequence of Environment resources.

LookupEnvironmentHistoryAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment> LookupEnvironmentHistoryAsync(string name, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageToken	System.String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.Api.Gax.PagedAsyncEnumerable<LookupEnvironmentHistoryResponse, Environment>	A pageable asynchronous sequence of Environment resources.

PollOnceCreateEnvironment(String, CallSettings)

public virtual Operation<Environment, Struct> PollOnceCreateEnvironment(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateEnvironment .

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The result of polling the operation.

PollOnceCreateEnvironmentAsync(String, CallSettings)

public virtual Task<Operation<Environment, Struct>> PollOnceCreateEnvironmentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateEnvironment.

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A task representing the result of polling the operation.

PollOnceUpdateEnvironment(String, CallSettings)

public virtual Operation<Environment, Struct> PollOnceUpdateEnvironment(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateEnvironment .

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The result of polling the operation.

PollOnceUpdateEnvironmentAsync(String, CallSettings)

public virtual Task<Operation<Environment, Struct>> PollOnceUpdateEnvironmentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateEnvironment.

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
System.Threading.Tasks.Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateEnvironment(Environment, FieldMask, CallSettings)

public virtual Operation<Environment, Struct> UpdateEnvironment(Environment environment, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
environment	Environment Required. The environment to update.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The RPC response.

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

public virtual Operation<Environment, Struct> UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	UpdateEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>	The RPC response.

UpdateEnvironmentAsync(Environment, FieldMask, CallSettings)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(Environment environment, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
environment	Environment Required. The environment to update.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

UpdateEnvironmentAsync(Environment, FieldMask, CancellationToken)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(Environment environment, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
environment	Environment Required. The environment to update.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Required. The mask to control which fields get updated.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	UpdateEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Environment, Struct>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CancellationToken cancellationToken)

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	UpdateEnvironmentRequest The request object containing all of the parameters for the API call.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Environment, Google.Protobuf.WellKnownTypes.Struct>>	A Task containing the RPC response.