public final class Experiment extends GeneratedMessageV3 implements ExperimentOrBuilder
Represents an experiment in an environment.
Protobuf type google.cloud.dialogflow.cx.v3.Experiment
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEFINITION_FIELD_NUMBER
public static final int DEFINITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPERIMENT_LENGTH_FIELD_NUMBER
public static final int EXPERIMENT_LENGTH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LAST_UPDATE_TIME_FIELD_NUMBER
public static final int LAST_UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULT_FIELD_NUMBER
public static final int RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROLLOUT_CONFIG_FIELD_NUMBER
public static final int ROLLOUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROLLOUT_FAILURE_REASON_FIELD_NUMBER
public static final int ROLLOUT_FAILURE_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROLLOUT_STATE_FIELD_NUMBER
public static final int ROLLOUT_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VARIANTS_HISTORY_FIELD_NUMBER
public static final int VARIANTS_HISTORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Experiment getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Experiment.Builder newBuilder()
newBuilder(Experiment prototype)
public static Experiment.Builder newBuilder(Experiment prototype)
public static Experiment parseDelimitedFrom(InputStream input)
public static Experiment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Experiment parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Experiment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Experiment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Experiment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Experiment parseFrom(CodedInputStream input)
public static Experiment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Experiment parseFrom(InputStream input)
public static Experiment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Experiment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Experiment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Experiment> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Creation time of this experiment.
.google.protobuf.Timestamp create_time = 7;
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Creation time of this experiment.
.google.protobuf.Timestamp create_time = 7;
getDefaultInstanceForType()
public Experiment getDefaultInstanceForType()
getDefinition()
public Experiment.Definition getDefinition()
The definition of the experiment.
.google.cloud.dialogflow.cx.v3.Experiment.Definition definition = 5;
getDefinitionOrBuilder()
public Experiment.DefinitionOrBuilder getDefinitionOrBuilder()
The definition of the experiment.
.google.cloud.dialogflow.cx.v3.Experiment.Definition definition = 5;
getDescription()
public String getDescription()
The human-readable description of the experiment.
string description = 3;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
The human-readable description of the experiment.
string description = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public 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 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 Timestamp getEndTime()
End time of this experiment.
.google.protobuf.Timestamp end_time = 9;
| Returns |
| Type |
Description |
Timestamp |
The endTime.
|
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
End time of this experiment.
.google.protobuf.Timestamp end_time = 9;
getExperimentLength()
public 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 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;
getLastUpdateTime()
public Timestamp getLastUpdateTime()
Last update time of this experiment.
.google.protobuf.Timestamp last_update_time = 10;
| Returns |
| Type |
Description |
Timestamp |
The lastUpdateTime.
|
getLastUpdateTimeOrBuilder()
public TimestampOrBuilder getLastUpdateTimeOrBuilder()
Last update time of this experiment.
.google.protobuf.Timestamp last_update_time = 10;
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 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.
|
getParserForType()
public Parser<Experiment> getParserForType()
Overrides
getResult()
public Experiment.Result getResult()
Inference result of the experiment.
.google.cloud.dialogflow.cx.v3.Experiment.Result result = 6;
getResultOrBuilder()
public Experiment.ResultOrBuilder getResultOrBuilder()
Inference result of the experiment.
.google.cloud.dialogflow.cx.v3.Experiment.Result result = 6;
getRolloutConfig()
public 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;
getRolloutConfigOrBuilder()
public 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;
getRolloutFailureReason()
public 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 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 RolloutState getRolloutState()
State of the auto rollout process.
.google.cloud.dialogflow.cx.v3.RolloutState rollout_state = 15;
getRolloutStateOrBuilder()
public RolloutStateOrBuilder getRolloutStateOrBuilder()
State of the auto rollout process.
.google.cloud.dialogflow.cx.v3.RolloutState rollout_state = 15;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStartTime()
public Timestamp getStartTime()
Start time of this experiment.
.google.protobuf.Timestamp start_time = 8;
| Returns |
| Type |
Description |
Timestamp |
The startTime.
|
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Start time of this experiment.
.google.protobuf.Timestamp start_time = 8;
getState()
public 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;
getStateValue()
public 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 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
|
getVariantsHistoryCount()
public 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 List<VariantsHistory> getVariantsHistoryList()
The history of updates to the experiment variants.
repeated .google.cloud.dialogflow.cx.v3.VariantsHistory variants_history = 12;
getVariantsHistoryOrBuilder(int index)
public 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
|
getVariantsHistoryOrBuilderList()
public 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 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 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 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 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 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 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 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 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 boolean hasStartTime()
Start time of this experiment.
.google.protobuf.Timestamp start_time = 8;
| Returns |
| Type |
Description |
boolean |
Whether the startTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Experiment.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Experiment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Experiment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
