Class Environments.EnvironmentsClient (1.1.0)

Version 1.1.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 class EnvironmentsClient : ClientBase<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.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.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 Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

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

Returns
Type	Description
Google.LongRunning.Operation	The response received from the server.

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

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(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 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
Google.LongRunning.Operation	The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

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

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

Returns
Type	Description
AsyncUnaryCall<Google.LongRunning.Operation>	The call object.

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

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(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 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<Google.LongRunning.Operation>	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
Google.LongRunning.Operations.OperationsClient	A new Operations client for the same target as this client.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Empty DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.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 [Environment][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.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 [Environment][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.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 [Environment][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.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.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.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 environments in the specified [Agent][google.cloud.dialogflow.cx.v3.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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.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.

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, CallOptions)

public virtual LookupEnvironmentHistoryResponse LookupEnvironmentHistory(LookupEnvironmentHistoryRequest request, CallOptions options)

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

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

Returns
Type	Description
LookupEnvironmentHistoryResponse	The response received from the server.

LookupEnvironmentHistory(LookupEnvironmentHistoryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LookupEnvironmentHistoryResponse LookupEnvironmentHistory(LookupEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
request	LookupEnvironmentHistoryRequest 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
LookupEnvironmentHistoryResponse	The response received from the server.

LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, CallOptions)

public virtual AsyncUnaryCall<LookupEnvironmentHistoryResponse> LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCall<LookupEnvironmentHistoryResponse>	The call object.

LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LookupEnvironmentHistoryResponse> LookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
request	LookupEnvironmentHistoryRequest 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<LookupEnvironmentHistoryResponse>	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.Cx.V3.Environments.EnvironmentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)

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

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

Returns
Type	Description
Google.LongRunning.Operation	The response received from the server.

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

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

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

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
Google.LongRunning.Operation	The response received from the server.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<Google.LongRunning.Operation>	The call object.

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

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

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

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<Google.LongRunning.Operation>	The call object.