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

Class Experiment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Experiment
All Implemented Interfaces:
ExperimentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Experiment extends com.google.protobuf.GeneratedMessage implements ExperimentOrBuilder
 Represents an experiment in an environment.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • DEFINITION_FIELD_NUMBER

      public static final int DEFINITION_FIELD_NUMBER
      See Also:

    • ROLLOUT_CONFIG_FIELD_NUMBER

      public static final int ROLLOUT_CONFIG_FIELD_NUMBER
      See Also:

    • ROLLOUT_STATE_FIELD_NUMBER

      public static final int ROLLOUT_STATE_FIELD_NUMBER
      See Also:

    • ROLLOUT_FAILURE_REASON_FIELD_NUMBER

      public static final int ROLLOUT_FAILURE_REASON_FIELD_NUMBER
      See Also:

    • RESULT_FIELD_NUMBER

      public static final int RESULT_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • LAST_UPDATE_TIME_FIELD_NUMBER

      public static final int LAST_UPDATE_TIME_FIELD_NUMBER
      See Also:

    • EXPERIMENT_LENGTH_FIELD_NUMBER

      public static final int EXPERIMENT_LENGTH_FIELD_NUMBER
      See Also:

    • VARIANTS_HISTORY_FIELD_NUMBER

      public static final int VARIANTS_HISTORY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

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

    • getNameBytes

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

    • 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];
      Specified by:
      getDisplayName in interface ExperimentOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       The human-readable description of the experiment.
      string description = 3;
      Specified by:
      getDescription in interface ExperimentOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

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

    • 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.v3beta1.Experiment.State state = 4;
      Specified by:
      getStateValue in interface ExperimentOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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.v3beta1.Experiment.State state = 4;
      Specified by:
      getState in interface ExperimentOrBuilder
      Returns:
      The state.

    • hasDefinition

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

    • getDefinition

      public Experiment.Definition getDefinition()
       The definition of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
      Specified by:
      getDefinition in interface ExperimentOrBuilder
      Returns:
      The definition.

    • getDefinitionOrBuilder

      public Experiment.DefinitionOrBuilder getDefinitionOrBuilder()
       The definition of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
      Specified by:
      getDefinitionOrBuilder in interface ExperimentOrBuilder

    • 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.v3beta1.RolloutConfig rollout_config = 14;
      Specified by:
      hasRolloutConfig in interface ExperimentOrBuilder
      Returns:
      Whether the rolloutConfig field is set.

    • 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.v3beta1.RolloutConfig rollout_config = 14;
      Specified by:
      getRolloutConfig in interface ExperimentOrBuilder
      Returns:
      The rolloutConfig.

    • 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.v3beta1.RolloutConfig rollout_config = 14;
      Specified by:
      getRolloutConfigOrBuilder in interface ExperimentOrBuilder

    • hasRolloutState

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

    • getRolloutState

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

    • getRolloutStateOrBuilder

      public RolloutStateOrBuilder getRolloutStateOrBuilder()
       State of the auto rollout process.
      .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
      Specified by:
      getRolloutStateOrBuilder in interface ExperimentOrBuilder

    • getRolloutFailureReason

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

    • getRolloutFailureReasonBytes

      public 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;
      Specified by:
      getRolloutFailureReasonBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for rolloutFailureReason.

    • hasResult

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

    • getResult

      public Experiment.Result getResult()
       Inference result of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
      Specified by:
      getResult in interface ExperimentOrBuilder
      Returns:
      The result.

    • getResultOrBuilder

      public Experiment.ResultOrBuilder getResultOrBuilder()
       Inference result of the experiment.
      .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
      Specified by:
      getResultOrBuilder in interface ExperimentOrBuilder

    • hasCreateTime

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

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Creation time of this experiment.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      getCreateTime in interface ExperimentOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Creation time of this experiment.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      getCreateTimeOrBuilder in interface ExperimentOrBuilder

    • hasStartTime

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

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Start time of this experiment.
      .google.protobuf.Timestamp start_time = 8;
      Specified by:
      getStartTime in interface ExperimentOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Start time of this experiment.
      .google.protobuf.Timestamp start_time = 8;
      Specified by:
      getStartTimeOrBuilder in interface ExperimentOrBuilder

    • hasEndTime

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

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       End time of this experiment.
      .google.protobuf.Timestamp end_time = 9;
      Specified by:
      getEndTime in interface ExperimentOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       End time of this experiment.
      .google.protobuf.Timestamp end_time = 9;
      Specified by:
      getEndTimeOrBuilder in interface ExperimentOrBuilder

    • hasLastUpdateTime

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

    • getLastUpdateTime

      public com.google.protobuf.Timestamp getLastUpdateTime()
       Last update time of this experiment.
      .google.protobuf.Timestamp last_update_time = 10;
      Specified by:
      getLastUpdateTime in interface ExperimentOrBuilder
      Returns:
      The lastUpdateTime.

    • getLastUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder()
       Last update time of this experiment.
      .google.protobuf.Timestamp last_update_time = 10;
      Specified by:
      getLastUpdateTimeOrBuilder in interface ExperimentOrBuilder

    • hasExperimentLength

      public 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;
      Specified by:
      hasExperimentLength in interface ExperimentOrBuilder
      Returns:
      Whether the experimentLength field is set.

    • getExperimentLength

      public 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;
      Specified by:
      getExperimentLength in interface ExperimentOrBuilder
      Returns:
      The experimentLength.

    • getExperimentLengthOrBuilder

      public 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;
      Specified by:
      getExperimentLengthOrBuilder in interface ExperimentOrBuilder

    • getVariantsHistoryList

      public List<VariantsHistory> getVariantsHistoryList()
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
      Specified by:
      getVariantsHistoryList in interface ExperimentOrBuilder

    • getVariantsHistoryOrBuilderList

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

    • getVariantsHistoryCount

      public int getVariantsHistoryCount()
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
      Specified by:
      getVariantsHistoryCount in interface ExperimentOrBuilder

    • getVariantsHistory

      public VariantsHistory getVariantsHistory(int index)
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
      Specified by:
      getVariantsHistory in interface ExperimentOrBuilder

    • getVariantsHistoryOrBuilder

      public VariantsHistoryOrBuilder getVariantsHistoryOrBuilder(int index)
       The history of updates to the experiment variants.
      repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
      Specified by:
      getVariantsHistoryOrBuilder in interface ExperimentOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Experiment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Experiment parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Experiment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Experiment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Experiment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Experiment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Experiment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Experiment.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Experiment.Builder newBuilder()

    • newBuilder

      public static Experiment.Builder newBuilder(Experiment prototype)

    • toBuilder

      public Experiment.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Experiment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Experiment getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Experiment> parser()

    • getParserForType

      public com.google.protobuf.Parser<Experiment> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Experiment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder