Class Experiment.Builder (0.28.0) 

public static final class Experiment.Builder extends GeneratedMessageV3.Builder<Experiment.Builder> implements ExperimentOrBuilder

Represents an experiment in an environment.

Protobuf type google.cloud.dialogflow.cx.v3.Experiment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Experiment.Builder

Implements

ExperimentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllVariantsHistory(Iterable<? extends VariantsHistory> values)

public Experiment.Builder addAllVariantsHistory(Iterable<? extends VariantsHistory> values)

The history of updates to the experiment variants.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.VariantsHistory>
Returns
Type Description
Experiment.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Experiment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Experiment.Builder
Overrides

addVariantsHistory(VariantsHistory value)

public Experiment.Builder addVariantsHistory(VariantsHistory value)

The history of updates to the experiment variants.

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

Parameter
Name Description
value VariantsHistory
Returns
Type Description
Experiment.Builder

addVariantsHistory(VariantsHistory.Builder builderForValue)

public Experiment.Builder addVariantsHistory(VariantsHistory.Builder builderForValue)

The history of updates to the experiment variants.

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

Parameter
Name Description
builderForValue VariantsHistory.Builder
Returns
Type Description
Experiment.Builder

addVariantsHistory(int index, VariantsHistory value)

public Experiment.Builder addVariantsHistory(int index, VariantsHistory value)

The history of updates to the experiment variants.

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

Parameters
Name Description
index int
value VariantsHistory
Returns
Type Description
Experiment.Builder

addVariantsHistory(int index, VariantsHistory.Builder builderForValue)

public Experiment.Builder addVariantsHistory(int index, VariantsHistory.Builder builderForValue)

The history of updates to the experiment variants.

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

Parameters
Name Description
index int
builderForValue VariantsHistory.Builder
Returns
Type Description
Experiment.Builder

addVariantsHistoryBuilder()

public VariantsHistory.Builder addVariantsHistoryBuilder()

The history of updates to the experiment variants.

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

Returns
Type Description
VariantsHistory.Builder

addVariantsHistoryBuilder(int index)

public VariantsHistory.Builder addVariantsHistoryBuilder(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.Builder

build()

public Experiment build()
Returns
Type Description
Experiment

buildPartial()

public Experiment buildPartial()
Returns
Type Description
Experiment

clear()

public Experiment.Builder clear()
Returns
Type Description
Experiment.Builder
Overrides

clearCreateTime()

public Experiment.Builder clearCreateTime()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Experiment.Builder

clearDefinition()

public Experiment.Builder clearDefinition()

The definition of the experiment.

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

Returns
Type Description
Experiment.Builder

clearDescription()

public Experiment.Builder clearDescription()

The human-readable description of the experiment.

string description = 3;

Returns
Type Description
Experiment.Builder

This builder for chaining.

clearDisplayName()

public Experiment.Builder clearDisplayName()

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
Experiment.Builder

This builder for chaining.

clearEndTime()

public Experiment.Builder clearEndTime()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type Description
Experiment.Builder

clearExperimentLength()

public Experiment.Builder clearExperimentLength()

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
Experiment.Builder

clearField(Descriptors.FieldDescriptor field)

public Experiment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Experiment.Builder
Overrides

clearLastUpdateTime()

public Experiment.Builder clearLastUpdateTime()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type Description
Experiment.Builder

clearName()

public Experiment.Builder clearName()

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
Experiment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Experiment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Experiment.Builder
Overrides

clearResult()

public Experiment.Builder clearResult()

Inference result of the experiment.

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

Returns
Type Description
Experiment.Builder

clearRolloutConfig()

public Experiment.Builder clearRolloutConfig()

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
Experiment.Builder

clearRolloutFailureReason()

public Experiment.Builder clearRolloutFailureReason()

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

string rollout_failure_reason = 16;

Returns
Type Description
Experiment.Builder

This builder for chaining.

clearRolloutState()

public Experiment.Builder clearRolloutState()

State of the auto rollout process.

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

Returns
Type Description
Experiment.Builder

clearStartTime()

public Experiment.Builder clearStartTime()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Experiment.Builder

clearState()

public Experiment.Builder clearState()

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

This builder for chaining.

clearVariantsHistory()

public Experiment.Builder clearVariantsHistory()

The history of updates to the experiment variants.

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

Returns
Type Description
Experiment.Builder

clone()

public Experiment.Builder clone()
Returns
Type Description
Experiment.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Experiment getDefaultInstanceForType()
Returns
Type Description
Experiment

getDefinition()

public Experiment.Definition getDefinition()

The definition of the experiment.

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

Returns
Type Description
Experiment.Definition

The definition.

getDefinitionBuilder()

public Experiment.Definition.Builder getDefinitionBuilder()

The definition of the experiment.

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

Returns
Type Description
Experiment.Definition.Builder

getDefinitionOrBuilder()

public Experiment.DefinitionOrBuilder getDefinitionOrBuilder()

The definition of the experiment.

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

Returns
Type Description
Experiment.DefinitionOrBuilder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Returns
Type Description
TimestampOrBuilder

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.

getExperimentLengthBuilder()

public Duration.Builder getExperimentLengthBuilder()

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
Builder

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;

Returns
Type Description
DurationOrBuilder

getLastUpdateTime()

public Timestamp getLastUpdateTime()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type Description
Timestamp

The lastUpdateTime.

getLastUpdateTimeBuilder()

public Timestamp.Builder getLastUpdateTimeBuilder()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type Description
Builder

getLastUpdateTimeOrBuilder()

public TimestampOrBuilder getLastUpdateTimeOrBuilder()

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Returns
Type Description
TimestampOrBuilder

getName()

public 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 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 Experiment.Result getResult()

Inference result of the experiment.

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

Returns
Type Description
Experiment.Result

The result.

getResultBuilder()

public Experiment.Result.Builder getResultBuilder()

Inference result of the experiment.

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

Returns
Type Description
Experiment.Result.Builder

getResultOrBuilder()

public Experiment.ResultOrBuilder getResultOrBuilder()

Inference result of the experiment.

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

Returns
Type Description
Experiment.ResultOrBuilder

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;

Returns
Type Description
RolloutConfig

The rolloutConfig.

getRolloutConfigBuilder()

public RolloutConfig.Builder getRolloutConfigBuilder()

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

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;

Returns
Type Description
RolloutConfigOrBuilder

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;

Returns
Type Description
RolloutState

The rolloutState.

getRolloutStateBuilder()

public RolloutState.Builder getRolloutStateBuilder()

State of the auto rollout process.

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

Returns
Type Description
RolloutState.Builder

getRolloutStateOrBuilder()

public RolloutStateOrBuilder getRolloutStateOrBuilder()

State of the auto rollout process.

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

Returns
Type Description
RolloutStateOrBuilder

getStartTime()

public Timestamp getStartTime()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
TimestampOrBuilder

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;

Returns
Type Description
Experiment.State

The state.

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
Returns
Type Description
VariantsHistory

getVariantsHistoryBuilder(int index)

public VariantsHistory.Builder getVariantsHistoryBuilder(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.Builder

getVariantsHistoryBuilderList()

public List<VariantsHistory.Builder> getVariantsHistoryBuilderList()

The history of updates to the experiment variants.

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

Returns
Type Description
List<Builder>

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;

Returns
Type Description
List<VariantsHistory>

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
Returns
Type Description
VariantsHistoryOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Experiment.Builder mergeCreateTime(Timestamp value)

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

mergeDefinition(Experiment.Definition value)

public Experiment.Builder mergeDefinition(Experiment.Definition value)

The definition of the experiment.

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

Parameter
Name Description
value Experiment.Definition
Returns
Type Description
Experiment.Builder

mergeEndTime(Timestamp value)

public Experiment.Builder mergeEndTime(Timestamp value)

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

mergeExperimentLength(Duration value)

public Experiment.Builder mergeExperimentLength(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
Experiment.Builder

mergeFrom(Experiment other)

public Experiment.Builder mergeFrom(Experiment other)
Parameter
Name Description
other Experiment
Returns
Type Description
Experiment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Experiment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Experiment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Experiment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Experiment.Builder
Overrides

mergeLastUpdateTime(Timestamp value)

public Experiment.Builder mergeLastUpdateTime(Timestamp value)

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

mergeResult(Experiment.Result value)

public Experiment.Builder mergeResult(Experiment.Result value)

Inference result of the experiment.

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

Parameter
Name Description
value Experiment.Result
Returns
Type Description
Experiment.Builder

mergeRolloutConfig(RolloutConfig value)

public Experiment.Builder mergeRolloutConfig(RolloutConfig value)

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;

Parameter
Name Description
value RolloutConfig
Returns
Type Description
Experiment.Builder

mergeRolloutState(RolloutState value)

public Experiment.Builder mergeRolloutState(RolloutState value)

State of the auto rollout process.

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

Parameter
Name Description
value RolloutState
Returns
Type Description
Experiment.Builder

mergeStartTime(Timestamp value)

public Experiment.Builder mergeStartTime(Timestamp value)

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Experiment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Experiment.Builder
Overrides

removeVariantsHistory(int index)

public Experiment.Builder removeVariantsHistory(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
Experiment.Builder

setCreateTime(Timestamp value)

public Experiment.Builder setCreateTime(Timestamp value)

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Experiment.Builder setCreateTime(Timestamp.Builder builderForValue)

Creation time of this experiment.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Experiment.Builder

setDefinition(Experiment.Definition value)

public Experiment.Builder setDefinition(Experiment.Definition value)

The definition of the experiment.

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

Parameter
Name Description
value Experiment.Definition
Returns
Type Description
Experiment.Builder

setDefinition(Experiment.Definition.Builder builderForValue)

public Experiment.Builder setDefinition(Experiment.Definition.Builder builderForValue)

The definition of the experiment.

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

Parameter
Name Description
builderForValue Experiment.Definition.Builder
Returns
Type Description
Experiment.Builder

setDescription(String value)

public Experiment.Builder setDescription(String value)

The human-readable description of the experiment.

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Experiment.Builder setDescriptionBytes(ByteString value)

The human-readable description of the experiment.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setDisplayName(String value)

public Experiment.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Experiment.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Experiment.Builder setEndTime(Timestamp value)

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

setEndTime(Timestamp.Builder builderForValue)

public Experiment.Builder setEndTime(Timestamp.Builder builderForValue)

End time of this experiment.

.google.protobuf.Timestamp end_time = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Experiment.Builder

setExperimentLength(Duration value)

public Experiment.Builder setExperimentLength(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
Experiment.Builder

setExperimentLength(Duration.Builder builderForValue)

public Experiment.Builder setExperimentLength(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Experiment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Experiment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Experiment.Builder
Overrides

setLastUpdateTime(Timestamp value)

public Experiment.Builder setLastUpdateTime(Timestamp value)

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

setLastUpdateTime(Timestamp.Builder builderForValue)

public Experiment.Builder setLastUpdateTime(Timestamp.Builder builderForValue)

Last update time of this experiment.

.google.protobuf.Timestamp last_update_time = 10;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Experiment.Builder

setName(String value)

public Experiment.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Experiment.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Experiment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Experiment.Builder
Overrides

setResult(Experiment.Result value)

public Experiment.Builder setResult(Experiment.Result value)

Inference result of the experiment.

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

Parameter
Name Description
value Experiment.Result
Returns
Type Description
Experiment.Builder

setResult(Experiment.Result.Builder builderForValue)

public Experiment.Builder setResult(Experiment.Result.Builder builderForValue)

Inference result of the experiment.

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

Parameter
Name Description
builderForValue Experiment.Result.Builder
Returns
Type Description
Experiment.Builder

setRolloutConfig(RolloutConfig value)

public Experiment.Builder setRolloutConfig(RolloutConfig value)

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;

Parameter
Name Description
value RolloutConfig
Returns
Type Description
Experiment.Builder

setRolloutConfig(RolloutConfig.Builder builderForValue)

public Experiment.Builder setRolloutConfig(RolloutConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RolloutConfig.Builder
Returns
Type Description
Experiment.Builder

setRolloutFailureReason(String value)

public Experiment.Builder setRolloutFailureReason(String value)

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

string rollout_failure_reason = 16;

Parameter
Name Description
value String

The rolloutFailureReason to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setRolloutFailureReasonBytes(ByteString value)

public Experiment.Builder setRolloutFailureReasonBytes(ByteString value)

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

string rollout_failure_reason = 16;

Parameter
Name Description
value ByteString

The bytes for rolloutFailureReason to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setRolloutState(RolloutState value)

public Experiment.Builder setRolloutState(RolloutState value)

State of the auto rollout process.

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

Parameter
Name Description
value RolloutState
Returns
Type Description
Experiment.Builder

setRolloutState(RolloutState.Builder builderForValue)

public Experiment.Builder setRolloutState(RolloutState.Builder builderForValue)

State of the auto rollout process.

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

Parameter
Name Description
builderForValue RolloutState.Builder
Returns
Type Description
Experiment.Builder

setStartTime(Timestamp value)

public Experiment.Builder setStartTime(Timestamp value)

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
Experiment.Builder

setStartTime(Timestamp.Builder builderForValue)

public Experiment.Builder setStartTime(Timestamp.Builder builderForValue)

Start time of this experiment.

.google.protobuf.Timestamp start_time = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Experiment.Builder

setState(Experiment.State value)

public Experiment.Builder setState(Experiment.State value)

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;

Parameter
Name Description
value Experiment.State

The state to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setStateValue(int value)

public Experiment.Builder setStateValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Experiment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Experiment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Experiment.Builder
Overrides

setVariantsHistory(int index, VariantsHistory value)

public Experiment.Builder setVariantsHistory(int index, VariantsHistory value)

The history of updates to the experiment variants.

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

Parameters
Name Description
index int
value VariantsHistory
Returns
Type Description
Experiment.Builder

setVariantsHistory(int index, VariantsHistory.Builder builderForValue)

public Experiment.Builder setVariantsHistory(int index, VariantsHistory.Builder builderForValue)

The history of updates to the experiment variants.

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

Parameters
Name Description
index int
builderForValue VariantsHistory.Builder
Returns
Type Description
Experiment.Builder