Struct google_api_proto::google::cloud::discoveryengine::v1alpha::Evaluation

pub struct Evaluation {
    pub name: String,
    pub evaluation_spec: Option<EvaluationSpec>,
    pub quality_metrics: Option<QualityMetrics>,
    pub state: i32,
    pub error: Option<Status>,
    pub create_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub error_samples: Vec<Status>,
}

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Fields

name: String

Identifier. The full resource name of the [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

evaluation_spec: Option<EvaluationSpec>

Required. The specification of the evaluation.

quality_metrics: Option<QualityMetrics>

Output only. The metrics produced by the evaluation, averaged across all [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s in the [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].

Only populated when the evaluation’s state is SUCCEEDED.

state: i32

Output only. The state of the evaluation.

error: Option<Status>

Output only. The error that occurred during evaluation. Only populated when the evaluation’s state is FAILED.

create_time: Option<Timestamp>

Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was created at.

end_time: Option<Timestamp>

Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was completed at.

error_samples: Vec<Status>

Output only. A sample of errors encountered while processing the request.

Implementations

impl Evaluation

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 Evaluation

fn clone(&self) -> Evaluation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Evaluation

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

Formats the value using the given formatter.

impl Default for Evaluation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Evaluation

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 Evaluation

fn eq(&self, other: &Evaluation) -> 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 Evaluation