Struct google_api_proto::google::cloud::dialogflow::cx::v3::Experiment

pub struct Experiment {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub state: i32,
    pub definition: Option<Definition>,
    pub rollout_config: Option<RolloutConfig>,
    pub rollout_state: Option<RolloutState>,
    pub rollout_failure_reason: String,
    pub result: Option<Result>,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub last_update_time: Option<Timestamp>,
    pub experiment_length: Option<Duration>,
    pub variants_history: Vec<VariantsHistory>,
}

Represents an experiment in an environment.

Fields

name: String

The name of the experiment. Format: projects//locations//agents//environments//experiments/..

display_name: String

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

description: String

The human-readable description of the experiment.

state: i32

The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

definition: Option<Definition>

The definition of the experiment.

rollout_config: Option<RolloutConfig>

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.

rollout_state: Option<RolloutState>

State of the auto rollout process.

rollout_failure_reason: String

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

result: Option<Result>

Inference result of the experiment.

create_time: Option<Timestamp>

Creation time of this experiment.

start_time: Option<Timestamp>

Start time of this experiment.

end_time: Option<Timestamp>

End time of this experiment.

last_update_time: Option<Timestamp>

Last update time of this experiment.

experiment_length: Option<Duration>

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.

variants_history: Vec<VariantsHistory>

The history of updates to the experiment variants.

Implementations

impl Experiment

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Experiment

fn clone(&self) -> Experiment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Experiment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Experiment

fn default() -> Self

Returns the “default value” for a type.

impl Message for Experiment

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Experiment

fn eq(&self, other: &Experiment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Experiment