class ProjectsLocationsAgentsEnvironmentsExperiments extends Resource (View source)

The "experiments" collection of methods.

Typical usage is:

 $dialogflowService = new Google\Service\Dialogflow(...);
 $experiments = $dialogflowService->projects_locations_agents_environments_experiments;

Methods

create(string $parent, GoogleCloudDialogflowCxV3Experiment $postBody, array $optParams = [])

Creates an Experiment in the specified Environment. (experiments.create)

delete(string $name, array $optParams = [])

Deletes the specified Experiment. (experiments.delete)

get(string $name, array $optParams = [])

Retrieves the specified Experiment. (experiments.get)

listProjectsLocationsAgentsEnvironmentsExperiments(string $parent, array $optParams = [])

Returns the list of all experiments in the specified Environment.

patch(string $name, GoogleCloudDialogflowCxV3Experiment $postBody, array $optParams = [])

Updates the specified Experiment. (experiments.patch)

start(string $name, GoogleCloudDialogflowCxV3StartExperimentRequest $postBody, array $optParams = [])

Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING. (experiments.start)

stop(string $name, GoogleCloudDialogflowCxV3StopExperimentRequest $postBody, array $optParams = [])

Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE. (experiments.stop)

Details

GoogleCloudDialogflowCxV3Experiment create(string $parent, GoogleCloudDialogflowCxV3Experiment $postBody, array $optParams = [])

Creates an Experiment in the specified Environment. (experiments.create)

Parameters

string $parent

Required. The Agent to create an Environment for. Format: projects//locations//agents//environments/.

GoogleCloudDialogflowCxV3Experiment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Experiment

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes the specified Experiment. (experiments.delete)

Parameters

string $name

Required. The name of the Environment to delete. Format: projects//locations//agents//environments//experiments/.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudDialogflowCxV3Experiment get(string $name, array $optParams = [])

Retrieves the specified Experiment. (experiments.get)

Parameters

string $name

Required. The name of the Environment. Format: projects//locations//agents//environments//experiments/.

array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Experiment

Exceptions

Exception

GoogleCloudDialogflowCxV3ListExperimentsResponse listProjectsLocationsAgentsEnvironmentsExperiments(string $parent, array $optParams = [])

Returns the list of all experiments in the specified Environment.

(experiments.listProjectsLocationsAgentsEnvironmentsExperiments)

Parameters

string $parent

Required. The Environment to list all environments for. Format: projects//locations//agents//environments/.

array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3ListExperimentsResponse

Exceptions

Exception

GoogleCloudDialogflowCxV3Experiment patch(string $name, GoogleCloudDialogflowCxV3Experiment $postBody, array $optParams = [])

Updates the specified Experiment. (experiments.patch)

Parameters

string $name

The name of the experiment. Format: projects//locations//agents//environments//experiments/.

GoogleCloudDialogflowCxV3Experiment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Experiment

Exceptions

Exception

GoogleCloudDialogflowCxV3Experiment start(string $name, GoogleCloudDialogflowCxV3StartExperimentRequest $postBody, array $optParams = [])

Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING. (experiments.start)

Parameters

string $name

Required. Resource name of the experiment to start. Format: projects//locations//agents//environments//experiments/.

GoogleCloudDialogflowCxV3StartExperimentRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Experiment

Exceptions

Exception

GoogleCloudDialogflowCxV3Experiment stop(string $name, GoogleCloudDialogflowCxV3StopExperimentRequest $postBody, array $optParams = [])

Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE. (experiments.stop)

Parameters

string $name

Required. Resource name of the experiment to stop. Format: projects//locations//agents//environments//experiments/.

GoogleCloudDialogflowCxV3StopExperimentRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Experiment

Exceptions

Exception