Class ExperimentsClient (1.0.0)

public abstract class ExperimentsClient

Experiments client wrapper, for convenient use.

Inheritance

System.Object > ExperimentsClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Experiments][google.cloud.dialogflow.cx.v3.Experiment].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Experiments scopes.

Property Value
TypeDescription
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

GrpcClient

public virtual Experiments.ExperimentsClient GrpcClient { get; }

The underlying gRPC Experiments client

Property Value
TypeDescription
Experiments.ExperimentsClient

Methods

Create()

public static ExperimentsClient Create()

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

Returns
TypeDescription
ExperimentsClient

The created ExperimentsClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenSystem.Threading.CancellationToken

The System.Threading.CancellationToken to use while creating the client.

Returns
TypeDescription
System.Threading.Tasks.Task<ExperimentsClient>

The task representing the created ExperimentsClient.

CreateExperiment(CreateExperimentRequest, CallSettings)

public virtual Experiment CreateExperiment(CreateExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

CreateExperiment(EnvironmentName, Experiment, CallSettings)

public virtual Experiment CreateExperiment(EnvironmentName parent, Experiment experiment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentEnvironmentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

CreateExperiment(String, Experiment, CallSettings)

public virtual Experiment CreateExperiment(string parent, Experiment experiment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentSystem.String

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

CreateExperimentAsync(CreateExperimentRequest, CallSettings)

public virtual Task<Experiment> CreateExperimentAsync(CreateExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

CreateExperimentAsync(CreateExperimentRequest, CancellationToken)

public virtual Task<Experiment> CreateExperimentAsync(CreateExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestCreateExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

CreateExperimentAsync(EnvironmentName, Experiment, CallSettings)

public virtual Task<Experiment> CreateExperimentAsync(EnvironmentName parent, Experiment experiment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentEnvironmentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

CreateExperimentAsync(EnvironmentName, Experiment, CancellationToken)

public virtual Task<Experiment> CreateExperimentAsync(EnvironmentName parent, Experiment experiment, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentEnvironmentName

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

CreateExperimentAsync(String, Experiment, CallSettings)

public virtual Task<Experiment> CreateExperimentAsync(string parent, Experiment experiment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentSystem.String

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

CreateExperimentAsync(String, Experiment, CancellationToken)

public virtual Task<Experiment> CreateExperimentAsync(string parent, Experiment experiment, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentSystem.String

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

experimentExperiment

Required. The experiment to create.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

DeleteExperiment(DeleteExperimentRequest, CallSettings)

public virtual void DeleteExperiment(DeleteExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDeleteExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteExperiment(ExperimentName, CallSettings)

public virtual void DeleteExperiment(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteExperiment(String, CallSettings)

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

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteExperimentAsync(DeleteExperimentRequest, CallSettings)

public virtual Task DeleteExperimentAsync(DeleteExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDeleteExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteExperimentAsync(DeleteExperimentRequest, CancellationToken)

public virtual Task DeleteExperimentAsync(DeleteExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestDeleteExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteExperimentAsync(ExperimentName, CallSettings)

public virtual Task DeleteExperimentAsync(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteExperimentAsync(ExperimentName, CancellationToken)

public virtual Task DeleteExperimentAsync(ExperimentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteExperimentAsync(String, CallSettings)

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

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteExperimentAsync(String, CancellationToken)

public virtual Task DeleteExperimentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task

A Task containing the RPC response.

GetExperiment(ExperimentName, CallSettings)

public virtual Experiment GetExperiment(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

GetExperiment(GetExperimentRequest, CallSettings)

public virtual Experiment GetExperiment(GetExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

GetExperiment(String, CallSettings)

public virtual Experiment GetExperiment(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

GetExperimentAsync(ExperimentName, CallSettings)

public virtual Task<Experiment> GetExperimentAsync(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

GetExperimentAsync(ExperimentName, CancellationToken)

public virtual Task<Experiment> GetExperimentAsync(ExperimentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameExperimentName

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

GetExperimentAsync(GetExperimentRequest, CallSettings)

public virtual Task<Experiment> GetExperimentAsync(GetExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

GetExperimentAsync(GetExperimentRequest, CancellationToken)

public virtual Task<Experiment> GetExperimentAsync(GetExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestGetExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

GetExperimentAsync(String, CallSettings)

public virtual Task<Experiment> GetExperimentAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

GetExperimentAsync(String, CancellationToken)

public virtual Task<Experiment> GetExperimentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameSystem.String

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

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

public virtual PagedEnumerable<ListExperimentsResponse, Experiment> ListExperiments(EnvironmentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentEnvironmentName

Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

pageTokenSystem.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeSystem.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.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedEnumerable<ListExperimentsResponse, Experiment>

A pageable sequence of Experiment resources.

ListExperiments(ListExperimentsRequest, CallSettings)

public virtual PagedEnumerable<ListExperimentsResponse, Experiment> ListExperiments(ListExperimentsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListExperimentsRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedEnumerable<ListExperimentsResponse, Experiment>

A pageable sequence of Experiment resources.

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

public virtual PagedEnumerable<ListExperimentsResponse, Experiment> ListExperiments(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentSystem.String

Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

pageTokenSystem.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeSystem.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.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedEnumerable<ListExperimentsResponse, Experiment>

A pageable sequence of Experiment resources.

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

public virtual PagedAsyncEnumerable<ListExperimentsResponse, Experiment> ListExperimentsAsync(EnvironmentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentEnvironmentName

Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

pageTokenSystem.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeSystem.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.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedAsyncEnumerable<ListExperimentsResponse, Experiment>

A pageable asynchronous sequence of Experiment resources.

ListExperimentsAsync(ListExperimentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListExperimentsResponse, Experiment> ListExperimentsAsync(ListExperimentsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListExperimentsRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedAsyncEnumerable<ListExperimentsResponse, Experiment>

A pageable asynchronous sequence of Experiment resources.

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

public virtual PagedAsyncEnumerable<ListExperimentsResponse, Experiment> ListExperimentsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentSystem.String

Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;.

pageTokenSystem.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeSystem.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.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Api.Gax.PagedAsyncEnumerable<ListExperimentsResponse, Experiment>

A pageable asynchronous sequence of Experiment resources.

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
TypeDescription
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.

StartExperiment(ExperimentName, CallSettings)

public virtual Experiment StartExperiment(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StartExperiment(StartExperimentRequest, CallSettings)

public virtual Experiment StartExperiment(StartExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestStartExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StartExperiment(String, CallSettings)

public virtual Experiment StartExperiment(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StartExperimentAsync(ExperimentName, CallSettings)

public virtual Task<Experiment> StartExperimentAsync(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StartExperimentAsync(ExperimentName, CancellationToken)

public virtual Task<Experiment> StartExperimentAsync(ExperimentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StartExperimentAsync(StartExperimentRequest, CallSettings)

public virtual Task<Experiment> StartExperimentAsync(StartExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestStartExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StartExperimentAsync(StartExperimentRequest, CancellationToken)

public virtual Task<Experiment> StartExperimentAsync(StartExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestStartExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StartExperimentAsync(String, CallSettings)

public virtual Task<Experiment> StartExperimentAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StartExperimentAsync(String, CancellationToken)

public virtual Task<Experiment> StartExperimentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to start. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperiment(ExperimentName, CallSettings)

public virtual Experiment StopExperiment(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StopExperiment(StopExperimentRequest, CallSettings)

public virtual Experiment StopExperiment(StopExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestStopExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StopExperiment(String, CallSettings)

public virtual Experiment StopExperiment(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

StopExperimentAsync(ExperimentName, CallSettings)

public virtual Task<Experiment> StopExperimentAsync(ExperimentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperimentAsync(ExperimentName, CancellationToken)

public virtual Task<Experiment> StopExperimentAsync(ExperimentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameExperimentName

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperimentAsync(StopExperimentRequest, CallSettings)

public virtual Task<Experiment> StopExperimentAsync(StopExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestStopExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperimentAsync(StopExperimentRequest, CancellationToken)

public virtual Task<Experiment> StopExperimentAsync(StopExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestStopExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperimentAsync(String, CallSettings)

public virtual Task<Experiment> StopExperimentAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

StopExperimentAsync(String, CancellationToken)

public virtual Task<Experiment> StopExperimentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameSystem.String

Required. Resource name of the experiment to stop. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/experiments/&amp;lt;Experiment ID&amp;gt;.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

UpdateExperiment(Experiment, FieldMask, CallSettings)

public virtual Experiment UpdateExperiment(Experiment experiment, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
NameDescription
experimentExperiment

Required. The experiment to update.

updateMaskGoogle.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

UpdateExperiment(UpdateExperimentRequest, CallSettings)

public virtual Experiment UpdateExperiment(UpdateExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Experiment

The RPC response.

UpdateExperimentAsync(Experiment, FieldMask, CallSettings)

public virtual Task<Experiment> UpdateExperimentAsync(Experiment experiment, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
NameDescription
experimentExperiment

Required. The experiment to update.

updateMaskGoogle.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

UpdateExperimentAsync(Experiment, FieldMask, CancellationToken)

public virtual Task<Experiment> UpdateExperimentAsync(Experiment experiment, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
NameDescription
experimentExperiment

Required. The experiment to update.

updateMaskGoogle.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

UpdateExperimentAsync(UpdateExperimentRequest, CallSettings)

public virtual Task<Experiment> UpdateExperimentAsync(UpdateExperimentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateExperimentRequest

The request object containing all of the parameters for the API call.

callSettingsGoogle.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.

UpdateExperimentAsync(UpdateExperimentRequest, CancellationToken)

public virtual Task<Experiment> UpdateExperimentAsync(UpdateExperimentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestUpdateExperimentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
System.Threading.Tasks.Task<Experiment>

A Task containing the RPC response.