Package com.google.cloud.dialogflow.cx.v3beta1

Interface ExperimentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Experiment, Experiment.Builder
@Generated public interface ExperimentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The name of the experiment.
 Format:
 projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the experiment.
 Format:
 projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getDescription

      String getDescription()
       The human-readable description of the experiment.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The human-readable description of the experiment.
      string description = 3;
      Returns:
      The bytes for description.

    • getStateValue

      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.v3beta1.Experiment.State state = 4;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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.v3beta1.Experiment.State state = 4;
      Returns:
      The state.

    • hasDefinition

      boolean hasDefinition()
       The definition of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
      Returns:
      Whether the definition field is set.

    • getDefinition

      Experiment.Definition getDefinition()
       The definition of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
      Returns:
      The definition.

    • getDefinitionOrBuilder

      Experiment.DefinitionOrBuilder getDefinitionOrBuilder()
       The definition of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;

    • hasRolloutConfig

      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.v3beta1.RolloutConfig rollout_config = 14;
      Returns:
      Whether the rolloutConfig field is set.

    • getRolloutConfig

      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.v3beta1.RolloutConfig rollout_config = 14;
      Returns:
      The rolloutConfig.

    • getRolloutConfigOrBuilder

      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.v3beta1.RolloutConfig rollout_config = 14;

    • hasRolloutState

      boolean hasRolloutState()
       State of the auto rollout process.
      .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
      Returns:
      Whether the rolloutState field is set.

    • getRolloutState

      RolloutState getRolloutState()
       State of the auto rollout process.
      .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
      Returns:
      The rolloutState.

    • getRolloutStateOrBuilder

      RolloutStateOrBuilder getRolloutStateOrBuilder()
       State of the auto rollout process.
      .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;

    • getRolloutFailureReason

      String getRolloutFailureReason()
       The reason why rollout has failed. Should only be set when state is
 ROLLOUT_FAILED.
      string rollout_failure_reason = 16;
      Returns:
      The rolloutFailureReason.

    • getRolloutFailureReasonBytes

      com.google.protobuf.ByteString getRolloutFailureReasonBytes()
       The reason why rollout has failed. Should only be set when state is
 ROLLOUT_FAILED.
      string rollout_failure_reason = 16;
      Returns:
      The bytes for rolloutFailureReason.

    • hasResult

      boolean hasResult()
       Inference result of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
      Returns:
      Whether the result field is set.

    • getResult

      Experiment.Result getResult()
       Inference result of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
      Returns:
      The result.

    • getResultOrBuilder

      Experiment.ResultOrBuilder getResultOrBuilder()
       Inference result of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;

    • hasCreateTime

      boolean hasCreateTime()
       Creation time of this experiment.
      .google.protobuf.Timestamp create_time = 7;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Creation time of this experiment.
      .google.protobuf.Timestamp create_time = 7;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Creation time of this experiment.
      .google.protobuf.Timestamp create_time = 7;

    • hasStartTime

      boolean hasStartTime()
       Start time of this experiment.
      .google.protobuf.Timestamp start_time = 8;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       Start time of this experiment.
      .google.protobuf.Timestamp start_time = 8;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Start time of this experiment.
      .google.protobuf.Timestamp start_time = 8;

    • hasEndTime

      boolean hasEndTime()
       End time of this experiment.
      .google.protobuf.Timestamp end_time = 9;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      com.google.protobuf.Timestamp getEndTime()
       End time of this experiment.
      .google.protobuf.Timestamp end_time = 9;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       End time of this experiment.
      .google.protobuf.Timestamp end_time = 9;

    • hasLastUpdateTime

      boolean hasLastUpdateTime()
       Last update time of this experiment.
      .google.protobuf.Timestamp last_update_time = 10;
      Returns:
      Whether the lastUpdateTime field is set.

    • getLastUpdateTime

      com.google.protobuf.Timestamp getLastUpdateTime()
       Last update time of this experiment.
      .google.protobuf.Timestamp last_update_time = 10;
      Returns:
      The lastUpdateTime.

    • getLastUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder()
       Last update time of this experiment.
      .google.protobuf.Timestamp last_update_time = 10;

    • hasExperimentLength

      boolean hasExperimentLength()
       Maximum number of days to run the experiment. 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:
      Whether the experimentLength field is set.

    • getExperimentLength

      com.google.protobuf.Duration getExperimentLength()
       Maximum number of days to run the experiment. 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:
      The experimentLength.

    • getExperimentLengthOrBuilder

      com.google.protobuf.DurationOrBuilder getExperimentLengthOrBuilder()
       Maximum number of days to run the experiment. 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;

    • getVariantsHistoryList

      List<VariantsHistory> getVariantsHistoryList()
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;

    • getVariantsHistory

      VariantsHistory getVariantsHistory(int index)
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;

    • getVariantsHistoryCount

      int getVariantsHistoryCount()
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;

    • getVariantsHistoryOrBuilderList

      List<? extends VariantsHistoryOrBuilder> getVariantsHistoryOrBuilderList()
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;

    • getVariantsHistoryOrBuilder

      VariantsHistoryOrBuilder getVariantsHistoryOrBuilder(int index)
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;