Struct google_api_proto::google::cloud::discoveryengine::v1alpha::engine::RecommendationMetadata

pub struct RecommendationMetadata {
    pub serving_state: i32,
    pub data_state: i32,
    pub last_tune_time: Option<Timestamp>,
    pub tuning_operation: String,
}

Additional information of a recommendation engine.

Fields

serving_state: i32

Output only. The serving state of the engine: ACTIVE, NOT_ACTIVE.

data_state: i32

Output only. The state of data requirements for this engine: DATA_OK and DATA_ERROR.

Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.

last_tune_time: Option<Timestamp>

Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.

tuning_operation: String

Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines.

If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.

Implementations

impl RecommendationMetadata

pub fn serving_state(&self) -> ServingState

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

pub fn set_serving_state(&mut self, value: ServingState)

Sets serving_state to the provided enum value.

pub fn data_state(&self) -> DataState

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

pub fn set_data_state(&mut self, value: DataState)

Sets data_state to the provided enum value.

Trait Implementations

impl Clone for RecommendationMetadata

fn clone(&self) -> RecommendationMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecommendationMetadata

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

Formats the value using the given formatter.

impl Default for RecommendationMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for RecommendationMetadata

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 RecommendationMetadata

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