Dialogflow v3 API - Class Experiments.ExperimentsClient (2.14.0)

Version 2.14.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 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 Experiments.ExperimentsClient : ClientBase<Experiments.ExperimentsClient>

Reference documentation and code samples for the Dialogflow v3 API class Experiments.ExperimentsClient.

Client for Experiments

Inheritance

object > ClientBase > ClientBaseExperimentsExperimentsClient > Experiments.ExperimentsClient

Inherited Members

ClientBase<Experiments.ExperimentsClient>.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

ExperimentsClient()

protected ExperimentsClient()

Protected parameterless constructor to allow creation of test doubles.

ExperimentsClient(CallInvoker)

public ExperimentsClient(CallInvoker callInvoker)

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

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

ExperimentsClient(ChannelBase)

public ExperimentsClient(ChannelBase channel)

Creates a new client for Experiments

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

ExperimentsClient(ClientBaseConfiguration)

protected ExperimentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateExperiment(CreateExperimentRequest, CallOptions)

public virtual Experiment CreateExperiment(CreateExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
Experiment	The response received from the server.

CreateExperiment(CreateExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual Experiment CreateExperiment(CreateExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Experiment	The response received from the server.

CreateExperimentAsync(CreateExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Experiment> CreateExperimentAsync(CreateExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallExperiment	The call object.

CreateExperimentAsync(CreateExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Experiment> CreateExperimentAsync(CreateExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallExperiment	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.

DeleteExperiment(DeleteExperimentRequest, CallOptions)

public virtual Empty DeleteExperiment(DeleteExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
Empty	The response received from the server.

DeleteExperiment(DeleteExperimentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	DeleteExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

DeleteExperimentAsync(DeleteExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteExperimentAsync(DeleteExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteExperimentAsync(DeleteExperimentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	DeleteExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallEmpty	The call object.

GetExperiment(GetExperimentRequest, CallOptions)

public virtual Experiment GetExperiment(GetExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
Experiment	The response received from the server.

GetExperiment(GetExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual Experiment GetExperiment(GetExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Experiment	The response received from the server.

GetExperimentAsync(GetExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Experiment> GetExperimentAsync(GetExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallExperiment	The call object.

GetExperimentAsync(GetExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Experiment> GetExperimentAsync(GetExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallExperiment	The call object.

ListExperiments(ListExperimentsRequest, CallOptions)

public virtual ListExperimentsResponse ListExperiments(ListExperimentsRequest request, CallOptions options)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

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

Returns
Type	Description
ListExperimentsResponse	The response received from the server.

ListExperiments(ListExperimentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListExperimentsResponse ListExperiments(ListExperimentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	ListExperimentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ListExperimentsResponse	The response received from the server.

ListExperimentsAsync(ListExperimentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListExperimentsResponse> ListExperimentsAsync(ListExperimentsRequest request, CallOptions options)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

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

Returns
Type	Description
AsyncUnaryCallListExperimentsResponse	The call object.

ListExperimentsAsync(ListExperimentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListExperimentsResponse> ListExperimentsAsync(ListExperimentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
Name	Description
request	ListExperimentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListExperimentsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Experiments.ExperimentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ExperimentsExperimentsClient

Overrides

ClientBase<Experiments.ExperimentsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

StartExperiment(StartExperimentRequest, CallOptions)

public virtual Experiment StartExperiment(StartExperimentRequest request, CallOptions options)

Starts the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.

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

Returns
Type	Description
Experiment	The response received from the server.

StartExperiment(StartExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual Experiment StartExperiment(StartExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.

Parameters
Name	Description
request	StartExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Experiment	The response received from the server.

StartExperimentAsync(StartExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Experiment> StartExperimentAsync(StartExperimentRequest request, CallOptions options)

Starts the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.

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

Returns
Type	Description
AsyncUnaryCallExperiment	The call object.

StartExperimentAsync(StartExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Experiment> StartExperimentAsync(StartExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.

Parameters
Name	Description
request	StartExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallExperiment	The call object.

StopExperiment(StopExperimentRequest, CallOptions)

public virtual Experiment StopExperiment(StopExperimentRequest request, CallOptions options)

Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.

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

Returns
Type	Description
Experiment	The response received from the server.

StopExperiment(StopExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual Experiment StopExperiment(StopExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.

Parameters
Name	Description
request	StopExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Experiment	The response received from the server.

StopExperimentAsync(StopExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Experiment> StopExperimentAsync(StopExperimentRequest request, CallOptions options)

Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.

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

Returns
Type	Description
AsyncUnaryCallExperiment	The call object.

StopExperimentAsync(StopExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Experiment> StopExperimentAsync(StopExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.

Parameters
Name	Description
request	StopExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallExperiment	The call object.

UpdateExperiment(UpdateExperimentRequest, CallOptions)

public virtual Experiment UpdateExperiment(UpdateExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
Experiment	The response received from the server.

UpdateExperiment(UpdateExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual Experiment UpdateExperiment(UpdateExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Experiment	The response received from the server.

UpdateExperimentAsync(UpdateExperimentRequest, CallOptions)

public virtual AsyncUnaryCall<Experiment> UpdateExperimentAsync(UpdateExperimentRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallExperiment	The call object.

UpdateExperimentAsync(UpdateExperimentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Experiment> UpdateExperimentAsync(UpdateExperimentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateExperimentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallExperiment	The call object.