Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Experiment.
Represents an experiment in an environment.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.Experiment
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of the experiment. Format: projects/
↳ display_name
string
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
↳ description
string
The human-readable description of the experiment.
↳ state
int
The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
The history of updates to the experiment variants.
getName
The name of the experiment.
Format:
projects/
Returns
Type
Description
string
setName
The name of the experiment.
Format:
projects/
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Required. The human-readable name of the experiment (unique in an
environment). Limit of 64 characters.
Returns
Type
Description
string
setDisplayName
Required. The human-readable name of the experiment (unique in an
environment). Limit of 64 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
The human-readable description of the experiment.
Returns
Type
Description
string
setDescription
The human-readable description of the experiment.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getState
The current state of the experiment.
Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING.
Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or
RUNNING->DONE.
Returns
Type
Description
int
setState
The current state of the experiment.
Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING.
Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or
RUNNING->DONE.
The configuration for auto rollout. If set, there should be exactly two
variants in the experiment (control variant being the default version of
the flow), the traffic allocation for the non-control variant will
gradually increase to 100% when conditions are met, and eventually
replace the control variant to become the default version of the flow.
The configuration for auto rollout. If set, there should be exactly two
variants in the experiment (control variant being the default version of
the flow), the traffic allocation for the non-control variant will
gradually increase to 100% when conditions are met, and eventually
replace the control variant to become the default version of the flow.
Maximum number of days to run the experiment/rollout. If auto-rollout is
not enabled, default value and maximum will be 30 days. If auto-rollout is
enabled, default value and maximum will be 6 days.
Maximum number of days to run the experiment/rollout. If auto-rollout is
not enabled, default value and maximum will be 30 days. If auto-rollout is
enabled, default value and maximum will be 6 days.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class Experiment (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Experiment)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.Experiment)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.Experiment)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.Experiment)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.Experiment)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.Experiment)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.Experiment)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.Experiment)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.Experiment) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Experiment.\n\nRepresents an experiment in an environment.\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.Experiment`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name of the experiment.\n\nFormat:\nprojects/\n\n\n### setName\n\nThe name of the experiment.\n\nFormat:\nprojects/\n\n\n### getDisplayName\n\nRequired. The human-readable name of the experiment (unique in an\nenvironment). Limit of 64 characters.\n\n### setDisplayName\n\nRequired. The human-readable name of the experiment (unique in an\nenvironment). Limit of 64 characters.\n\n### getDescription\n\nThe human-readable description of the experiment.\n\n### setDescription\n\nThe human-readable description of the experiment.\n\n### getState\n\nThe current state of the experiment.\n\nTransition triggered by Experiments.StartExperiment: DRAFT-\\\u003eRUNNING.\nTransition triggered by Experiments.CancelExperiment: DRAFT-\\\u003eDONE or\nRUNNING-\\\u003eDONE.\n\n### setState\n\nThe current state of the experiment.\n\nTransition triggered by Experiments.StartExperiment: DRAFT-\\\u003eRUNNING.\nTransition triggered by Experiments.CancelExperiment: DRAFT-\\\u003eDONE or\nRUNNING-\\\u003eDONE.\n\n### getDefinition\n\nThe definition of the experiment.\n\n### hasDefinition\n\n### clearDefinition\n\n### setDefinition\n\nThe definition of the experiment.\n\n### getRolloutConfig\n\nThe configuration for auto rollout. If set, there should be exactly two\nvariants in the experiment (control variant being the default version of\nthe flow), the traffic allocation for the non-control variant will\ngradually increase to 100% when conditions are met, and eventually\nreplace the control variant to become the default version of the flow.\n\n### hasRolloutConfig\n\n### clearRolloutConfig\n\n### setRolloutConfig\n\nThe configuration for auto rollout. If set, there should be exactly two\nvariants in the experiment (control variant being the default version of\nthe flow), the traffic allocation for the non-control variant will\ngradually increase to 100% when conditions are met, and eventually\nreplace the control variant to become the default version of the flow.\n\n### getRolloutState\n\nState of the auto rollout process.\n\n### hasRolloutState\n\n### clearRolloutState\n\n### setRolloutState\n\nState of the auto rollout process.\n\n### getRolloutFailureReason\n\nThe reason why rollout has failed. Should only be set when state is\nROLLOUT_FAILED.\n\n### setRolloutFailureReason\n\nThe reason why rollout has failed. Should only be set when state is\nROLLOUT_FAILED.\n\n### getResult\n\nInference result of the experiment.\n\n### hasResult\n\n### clearResult\n\n### setResult\n\nInference result of the experiment.\n\n### getCreateTime\n\nCreation time of this experiment.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nCreation time of this experiment.\n\n### getStartTime\n\nStart time of this experiment.\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nStart time of this experiment.\n\n### getEndTime\n\nEnd time of this experiment.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nEnd time of this experiment.\n\n### getLastUpdateTime\n\nLast update time of this experiment.\n\n### hasLastUpdateTime\n\n### clearLastUpdateTime\n\n### setLastUpdateTime\n\nLast update time of this experiment.\n\n### getExperimentLength\n\nMaximum number of days to run the experiment/rollout. If auto-rollout is\nnot enabled, default value and maximum will be 30 days. If auto-rollout is\nenabled, default value and maximum will be 6 days.\n\n### hasExperimentLength\n\n### clearExperimentLength\n\n### setExperimentLength\n\nMaximum number of days to run the experiment/rollout. If auto-rollout is\nnot enabled, default value and maximum will be 30 days. If auto-rollout is\nenabled, default value and maximum will be 6 days.\n\n### getVariantsHistory\n\nThe history of updates to the experiment variants.\n\n### setVariantsHistory\n\nThe history of updates to the experiment variants."]]
