Struct google_api_proto::google::cloud::discoveryengine::v1alpha::Engine

pub struct Engine {
    pub name: String,
    pub display_name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub data_store_ids: Vec<String>,
    pub solution_type: i32,
    pub industry_vertical: i32,
    pub common_config: Option<CommonConfig>,
    pub engine_config: Option<EngineConfig>,
    pub engine_metadata: Option<EngineMetadata>,
}

Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1alpha.Engine].

Fields

name: String

Immutable. The fully qualified resource name of the engine.

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

Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

display_name: String

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

create_time: Option<Timestamp>

Output only. Timestamp the Recommendation Engine was created at.

update_time: Option<Timestamp>

Output only. Timestamp the Recommendation Engine was last updated.

data_store_ids: Vec<String>

The data stores associated with this engine.

For [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH] and [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] type of engines, they can only associate with at most one data store.

If [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT], multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can be associated here.

Note that when used in [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest], one DataStore id must be provided as the system will use it for necessary initializations.

solution_type: i32

Required. The solutions of the engine.

industry_vertical: i32

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore linked to the engine.

common_config: Option<CommonConfig>

Common config spec that specifies the metadata of the engine.

engine_config: Option<EngineConfig>

Additional config specs that defines the behavior of the engine.

engine_metadata: Option<EngineMetadata>

Engine metadata to monitor the status of the engine.

Implementations

impl Engine

pub fn solution_type(&self) -> SolutionType

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

pub fn set_solution_type(&mut self, value: SolutionType)

Sets solution_type to the provided enum value.

pub fn industry_vertical(&self) -> IndustryVertical

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

pub fn set_industry_vertical(&mut self, value: IndustryVertical)

Sets industry_vertical to the provided enum value.

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Engine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Engine

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

Formats the value using the given formatter.

impl Default for Engine

fn default() -> Self

Returns the “default value” for a type.

impl Message for Engine

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 Engine

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