• Home
• com.google.api.grpc
• proto-google-cloud-dialogflow-cx-v3beta1
• 0.65.0
• source code
• ExperimentOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.dialogflow.cx.v3beta1.ExperimentOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/experiment.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface ExperimentOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Experiment)
    com.google.protobuf.MessageOrBuilder {

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

  /**
   *
   *
   * 
   * 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];
   *
   * @return The displayName.
   */
  java.lang.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];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * 
   * The human-readable description of the experiment.
   * 
   *
   * string description = 3;
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * 
   * The human-readable description of the experiment.
   * 
   *
   * string description = 3;
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   * 
   * 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;
   *
   * @return The enum numeric value on the wire for state.
   */
  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;
   *
   * @return The state.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Experiment.State getState();

  /**
   *
   *
   * 
   * The definition of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
   *
   * @return Whether the definition field is set.
   */
  boolean hasDefinition();
  /**
   *
   *
   * 
   * The definition of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
   *
   * @return The definition.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Experiment.Definition getDefinition();
  /**
   *
   *
   * 
   * The definition of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Definition definition = 5;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Experiment.DefinitionOrBuilder getDefinitionOrBuilder();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the rolloutConfig field is set.
   */
  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;
   *
   * @return The rolloutConfig.
   */
  com.google.cloud.dialogflow.cx.v3beta1.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;
   */
  com.google.cloud.dialogflow.cx.v3beta1.RolloutConfigOrBuilder getRolloutConfigOrBuilder();

  /**
   *
   *
   * 
   * State of the auto rollout process.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
   *
   * @return Whether the rolloutState field is set.
   */
  boolean hasRolloutState();
  /**
   *
   *
   * 
   * State of the auto rollout process.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
   *
   * @return The rolloutState.
   */
  com.google.cloud.dialogflow.cx.v3beta1.RolloutState getRolloutState();
  /**
   *
   *
   * 
   * State of the auto rollout process.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.RolloutState rollout_state = 15;
   */
  com.google.cloud.dialogflow.cx.v3beta1.RolloutStateOrBuilder getRolloutStateOrBuilder();

  /**
   *
   *
   * 
   * The reason why rollout has failed. Should only be set when state is
   * ROLLOUT_FAILED.
   * 
   *
   * string rollout_failure_reason = 16;
   *
   * @return The rolloutFailureReason.
   */
  java.lang.String getRolloutFailureReason();
  /**
   *
   *
   * 
   * The reason why rollout has failed. Should only be set when state is
   * ROLLOUT_FAILED.
   * 
   *
   * string rollout_failure_reason = 16;
   *
   * @return The bytes for rolloutFailureReason.
   */
  com.google.protobuf.ByteString getRolloutFailureReasonBytes();

  /**
   *
   *
   * 
   * Inference result of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
   *
   * @return Whether the result field is set.
   */
  boolean hasResult();
  /**
   *
   *
   * 
   * Inference result of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
   *
   * @return The result.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Experiment.Result getResult();
  /**
   *
   *
   * 
   * Inference result of the experiment.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Experiment.Result result = 6;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Experiment.ResultOrBuilder getResultOrBuilder();

  /**
   *
   *
   * 
   * Creation time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   * 
   * Creation time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   * 
   * Creation time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   * 
   * Start time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp start_time = 8;
   *
   * @return Whether the startTime field is set.
   */
  boolean hasStartTime();
  /**
   *
   *
   * 
   * Start time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp start_time = 8;
   *
   * @return The startTime.
   */
  com.google.protobuf.Timestamp getStartTime();
  /**
   *
   *
   * 
   * Start time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp start_time = 8;
   */
  com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();

  /**
   *
   *
   * 
   * End time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp end_time = 9;
   *
   * @return Whether the endTime field is set.
   */
  boolean hasEndTime();
  /**
   *
   *
   * 
   * End time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp end_time = 9;
   *
   * @return The endTime.
   */
  com.google.protobuf.Timestamp getEndTime();
  /**
   *
   *
   * 
   * End time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp end_time = 9;
   */
  com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();

  /**
   *
   *
   * 
   * Last update time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp last_update_time = 10;
   *
   * @return Whether the lastUpdateTime field is set.
   */
  boolean hasLastUpdateTime();
  /**
   *
   *
   * 
   * Last update time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp last_update_time = 10;
   *
   * @return The lastUpdateTime.
   */
  com.google.protobuf.Timestamp getLastUpdateTime();
  /**
   *
   *
   * 
   * Last update time of this experiment.
   * 
   *
   * .google.protobuf.Timestamp last_update_time = 10;
   */
  com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the experimentLength field is set.
   */
  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;
   *
   * @return The experimentLength.
   */
  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;
   */
  com.google.protobuf.DurationOrBuilder getExperimentLengthOrBuilder();

  /**
   *
   *
   * 
   * The history of updates to the experiment variants.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
   * 
   */
  java.util.List getVariantsHistoryList();
  /**
   *
   *
   * 
   * The history of updates to the experiment variants.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.VariantsHistory getVariantsHistory(int index);
  /**
   *
   *
   * 
   * The history of updates to the experiment variants.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
   * 
   */
  int getVariantsHistoryCount();
  /**
   *
   *
   * 
   * The history of updates to the experiment variants.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
   * 
   */
  java.util.List
      getVariantsHistoryOrBuilderList();
  /**
   *
   *
   * 
   * The history of updates to the experiment variants.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.VariantsHistory variants_history = 12;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.VariantsHistoryOrBuilder getVariantsHistoryOrBuilder(
      int index);
}