Struct GeneratorEvaluation 

#[non_exhaustive]
pub struct GeneratorEvaluation {
    pub name: String,
    pub display_name: String,
    pub generator_evaluation_config: Option<GeneratorEvaluationConfig>,
    pub create_time: Option<Timestamp>,
    pub complete_time: Option<Timestamp>,
    pub initial_generator: Option<Generator>,
    pub evaluation_status: Option<EvaluationStatus>,
    pub satisfies_pzs: Option<bool>,
    pub satisfies_pzi: Option<bool>,
    pub metrics: Option<Metrics>,
    /* private fields */
}

Available on crate feature generator-evaluations only.

Represents evaluation result of a generator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

display_name: String

Optional. The display name of the generator evaluation. At most 64 bytes long.

generator_evaluation_config: Option<GeneratorEvaluationConfig>

Required. The configuration of the evaluation task.

create_time: Option<Timestamp>

Output only. Creation time of this generator evaluation.

complete_time: Option<Timestamp>

Output only. Completion time of this generator evaluation.

initial_generator: Option<Generator>

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

evaluation_status: Option<EvaluationStatus>

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

satisfies_pzs: Option<bool>

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

satisfies_pzi: Option<bool>

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

metrics: Option<Metrics>

Metrics details.

Implementations

impl GeneratorEvaluation

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = GeneratorEvaluation::new().set_name("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = GeneratorEvaluation::new().set_display_name("example");

pub fn set_generator_evaluation_config<T>(self, v: T) -> Self

where T: Into<GeneratorEvaluationConfig>,

Sets the value of generator_evaluation_config.

Example

use google_cloud_dialogflow_v2::model::GeneratorEvaluationConfig;
let x = GeneratorEvaluation::new().set_generator_evaluation_config(GeneratorEvaluationConfig::default()/* use setters */);

pub fn set_or_clear_generator_evaluation_config<T>(self, v: Option<T>) -> Self

where T: Into<GeneratorEvaluationConfig>,

Sets or clears the value of generator_evaluation_config.

Example

use google_cloud_dialogflow_v2::model::GeneratorEvaluationConfig;
let x = GeneratorEvaluation::new().set_or_clear_generator_evaluation_config(Some(GeneratorEvaluationConfig::default()/* use setters */));
let x = GeneratorEvaluation::new().set_or_clear_generator_evaluation_config(None::<GeneratorEvaluationConfig>);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = GeneratorEvaluation::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = GeneratorEvaluation::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = GeneratorEvaluation::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_complete_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of complete_time.

Example

use wkt::Timestamp;
let x = GeneratorEvaluation::new().set_complete_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_complete_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of complete_time.

Example

use wkt::Timestamp;
let x = GeneratorEvaluation::new().set_or_clear_complete_time(Some(Timestamp::default()/* use setters */));
let x = GeneratorEvaluation::new().set_or_clear_complete_time(None::<Timestamp>);

pub fn set_initial_generator<T>(self, v: T) -> Self

where T: Into<Generator>,

Sets the value of initial_generator.

Example

use google_cloud_dialogflow_v2::model::Generator;
let x = GeneratorEvaluation::new().set_initial_generator(Generator::default()/* use setters */);

pub fn set_or_clear_initial_generator<T>(self, v: Option<T>) -> Self

where T: Into<Generator>,

Sets or clears the value of initial_generator.

Example

use google_cloud_dialogflow_v2::model::Generator;
let x = GeneratorEvaluation::new().set_or_clear_initial_generator(Some(Generator::default()/* use setters */));
let x = GeneratorEvaluation::new().set_or_clear_initial_generator(None::<Generator>);

pub fn set_evaluation_status<T>(self, v: T) -> Self

where T: Into<EvaluationStatus>,

Sets the value of evaluation_status.

Example

use google_cloud_dialogflow_v2::model::EvaluationStatus;
let x = GeneratorEvaluation::new().set_evaluation_status(EvaluationStatus::default()/* use setters */);

pub fn set_or_clear_evaluation_status<T>(self, v: Option<T>) -> Self

where T: Into<EvaluationStatus>,

Sets or clears the value of evaluation_status.

Example

use google_cloud_dialogflow_v2::model::EvaluationStatus;
let x = GeneratorEvaluation::new().set_or_clear_evaluation_status(Some(EvaluationStatus::default()/* use setters */));
let x = GeneratorEvaluation::new().set_or_clear_evaluation_status(None::<EvaluationStatus>);

pub fn set_satisfies_pzs<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of satisfies_pzs.

Example

let x = GeneratorEvaluation::new().set_satisfies_pzs(true);

pub fn set_or_clear_satisfies_pzs<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of satisfies_pzs.

Example

let x = GeneratorEvaluation::new().set_or_clear_satisfies_pzs(Some(false));
let x = GeneratorEvaluation::new().set_or_clear_satisfies_pzs(None::<bool>);

pub fn set_satisfies_pzi<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of satisfies_pzi.

Example

let x = GeneratorEvaluation::new().set_satisfies_pzi(true);

pub fn set_or_clear_satisfies_pzi<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of satisfies_pzi.

Example

let x = GeneratorEvaluation::new().set_or_clear_satisfies_pzi(Some(false));
let x = GeneratorEvaluation::new().set_or_clear_satisfies_pzi(None::<bool>);

pub fn set_metrics<T: Into<Option<Metrics>>>(self, v: T) -> Self

Sets the value of metrics.

Note that all the setters affecting metrics are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SummarizationEvaluationMetrics;
let x = GeneratorEvaluation::new().set_metrics(Some(
    google_cloud_dialogflow_v2::model::generator_evaluation::Metrics::SummarizationMetrics(SummarizationEvaluationMetrics::default().into())));

pub fn summarization_metrics( &self, ) -> Option<&Box<SummarizationEvaluationMetrics>>

The value of metrics if it holds a SummarizationMetrics, None if the field is not set or holds a different branch.

pub fn set_summarization_metrics<T: Into<Box<SummarizationEvaluationMetrics>>>( self, v: T, ) -> Self

Sets the value of metrics to hold a SummarizationMetrics.

Note that all the setters affecting metrics are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SummarizationEvaluationMetrics;
let x = GeneratorEvaluation::new().set_summarization_metrics(SummarizationEvaluationMetrics::default()/* use setters */);
assert!(x.summarization_metrics().is_some());

Trait Implementations

impl Clone for GeneratorEvaluation

fn clone(&self) -> GeneratorEvaluation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorEvaluation

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

Formats the value using the given formatter.

impl Default for GeneratorEvaluation

fn default() -> GeneratorEvaluation

Returns the “default value” for a type.

impl Message for GeneratorEvaluation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GeneratorEvaluation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for GeneratorEvaluation