Struct google_api_proto::google::cloud::aiplatform::v1::study_spec::MetricSpec

pub struct MetricSpec {
    pub metric_id: String,
    pub goal: i32,
    pub safety_config: Option<SafetyMetricConfig>,
}

Represents a metric to optimize.

Fields

metric_id: String

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

goal: i32

Required. The optimization goal of the metric.

safety_config: Option<SafetyMetricConfig>

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Implementations

impl MetricSpec

pub fn goal(&self) -> GoalType

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

pub fn set_goal(&mut self, value: GoalType)

Sets goal to the provided enum value.

Trait Implementations

impl Clone for MetricSpec

fn clone(&self) -> MetricSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricSpec

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

Formats the value using the given formatter.

impl Default for MetricSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for MetricSpec

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 MetricSpec

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