Interface ExperimentOrBuilder (0.58.0)

Version 0.58.0

• 0.66.0 (latest)
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface ExperimentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
TimestampOrBuilder

getDefinition()

public abstract Experiment.Definition getDefinition()

The definition of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Definition definition = 5;

Returns
Type	Description
Experiment.Definition	The definition.

getDefinitionOrBuilder()

public abstract Experiment.DefinitionOrBuilder getDefinitionOrBuilder()

The definition of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Definition definition = 5;

Returns
Type	Description
Experiment.DefinitionOrBuilder

getDescription()

public abstract String getDescription()

The human-readable description of the experiment.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The human-readable description of the experiment.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEndTime()

public abstract Timestamp getEndTime()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type	Description
TimestampOrBuilder

getExperimentLength()

public abstract Duration getExperimentLength()

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.

.google.protobuf.Duration experiment_length = 11;

Returns
Type	Description
Duration	The experimentLength.

getExperimentLengthOrBuilder()

public abstract DurationOrBuilder getExperimentLengthOrBuilder()

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.

.google.protobuf.Duration experiment_length = 11;

Returns
Type	Description
DurationOrBuilder

getLastUpdateTime()

public abstract Timestamp getLastUpdateTime()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type	Description
Timestamp	The lastUpdateTime.

getLastUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getLastUpdateTimeOrBuilder()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type	Description
TimestampOrBuilder

getName()

public abstract String getName()

The name of the experiment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>..

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the experiment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>..

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getResult()

public abstract Experiment.Result getResult()

Inference result of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Result result = 6;

Returns
Type	Description
Experiment.Result	The result.

getResultOrBuilder()

public abstract Experiment.ResultOrBuilder getResultOrBuilder()

Inference result of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Result result = 6;

Returns
Type	Description
Experiment.ResultOrBuilder

getRolloutConfig()

public abstract RolloutConfig getRolloutConfig()

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.

.google.cloud.dialogflow.cx.v3.RolloutConfig rollout_config = 14;

Returns
Type	Description
RolloutConfig	The rolloutConfig.

getRolloutConfigOrBuilder()

public abstract RolloutConfigOrBuilder getRolloutConfigOrBuilder()

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.

.google.cloud.dialogflow.cx.v3.RolloutConfig rollout_config = 14;

Returns
Type	Description
RolloutConfigOrBuilder

getRolloutFailureReason()

public abstract String getRolloutFailureReason()

The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

string rollout_failure_reason = 16;

Returns
Type	Description
String	The rolloutFailureReason.

getRolloutFailureReasonBytes()

public abstract ByteString getRolloutFailureReasonBytes()

The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

string rollout_failure_reason = 16;

Returns
Type	Description
ByteString	The bytes for rolloutFailureReason.

getRolloutState()

public abstract RolloutState getRolloutState()

State of the auto rollout process.

.google.cloud.dialogflow.cx.v3.RolloutState rollout_state = 15;

Returns
Type	Description
RolloutState	The rolloutState.

getRolloutStateOrBuilder()

public abstract RolloutStateOrBuilder getRolloutStateOrBuilder()

State of the auto rollout process.

.google.cloud.dialogflow.cx.v3.RolloutState rollout_state = 15;

Returns
Type	Description
RolloutStateOrBuilder

getStartTime()

public abstract Timestamp getStartTime()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
TimestampOrBuilder

getState()

public abstract Experiment.State getState()

The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

.google.cloud.dialogflow.cx.v3.Experiment.State state = 4;

Returns
Type	Description
Experiment.State	The state.

getStateValue()

public abstract int getStateValue()

The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

.google.cloud.dialogflow.cx.v3.Experiment.State state = 4;

Returns
Type	Description
int	The enum numeric value on the wire for state.

getVariantsHistory(int index)

public abstract VariantsHistory getVariantsHistory(int index)

The history of updates to the experiment variants.

repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
VariantsHistory

getVariantsHistoryCount()

public abstract int getVariantsHistoryCount()

The history of updates to the experiment variants.

repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;

Returns
Type	Description
int

getVariantsHistoryList()

public abstract List<VariantsHistory> getVariantsHistoryList()

The history of updates to the experiment variants.

repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;

Returns
Type	Description
List<VariantsHistory>

getVariantsHistoryOrBuilder(int index)

public abstract VariantsHistoryOrBuilder getVariantsHistoryOrBuilder(int index)

The history of updates to the experiment variants.

repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
VariantsHistoryOrBuilder

getVariantsHistoryOrBuilderList()

public abstract List<? extends VariantsHistoryOrBuilder> getVariantsHistoryOrBuilderList()

The history of updates to the experiment variants.

repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3.VariantsHistoryOrBuilder>

hasCreateTime()

public abstract boolean hasCreateTime()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDefinition()

public abstract boolean hasDefinition()

The definition of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Definition definition = 5;

Returns
Type	Description
boolean	Whether the definition field is set.

hasEndTime()

public abstract boolean hasEndTime()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type	Description
boolean	Whether the endTime field is set.

hasExperimentLength()

public abstract boolean hasExperimentLength()

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.

.google.protobuf.Duration experiment_length = 11;

Returns
Type	Description
boolean	Whether the experimentLength field is set.

hasLastUpdateTime()

public abstract boolean hasLastUpdateTime()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type	Description
boolean	Whether the lastUpdateTime field is set.

hasResult()

public abstract boolean hasResult()

Inference result of the experiment.

.google.cloud.dialogflow.cx.v3.Experiment.Result result = 6;

Returns
Type	Description
boolean	Whether the result field is set.

hasRolloutConfig()

public abstract boolean hasRolloutConfig()

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.

.google.cloud.dialogflow.cx.v3.RolloutConfig rollout_config = 14;

Returns
Type	Description
boolean	Whether the rolloutConfig field is set.

hasRolloutState()

public abstract boolean hasRolloutState()

State of the auto rollout process.

.google.cloud.dialogflow.cx.v3.RolloutState rollout_state = 15;

Returns
Type	Description
boolean	Whether the rolloutState field is set.

hasStartTime()

public abstract boolean hasStartTime()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
boolean	Whether the startTime field is set.