Struct google_api_proto::google::cloud::discoveryengine::v1alpha::Control

pub struct Control {
    pub name: String,
    pub display_name: String,
    pub associated_serving_config_ids: Vec<String>,
    pub solution_type: i32,
    pub use_cases: Vec<i32>,
    pub conditions: Vec<Condition>,
    pub action: Option<Action>,
}

Defines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] to be considered at serving time. Permitted actions dependent on SolutionType.

Fields

name: String

Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

display_name: String

Required. Human readable name. The identifier used in UI views.

Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.

associated_serving_config_ids: Vec<String>

Output only. List of all [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] IDs this control is attached to. May take up to 10 minutes to update after changes.

solution_type: i32

Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

use_cases: Vec<i32>

Specifies the use case for the control. Affects what condition fields can be set. Only applies to [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. Currently only allow one use case per control. Must be set when solution_type is [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].

conditions: Vec<Condition>

Determines when the associated action will trigger.

Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

action: Option<Action>

Actions are restricted by Vertical and Solution

Required.

Implementations

impl Control

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 use_cases( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<SearchUseCase>>

Returns an iterator which yields the valid enum values contained in use_cases.

pub fn push_use_cases(&mut self, value: SearchUseCase)

Appends the provided enum value to use_cases.

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Control

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

Formats the value using the given formatter.

impl Default for Control

fn default() -> Self

Returns the “default value” for a type.

impl Message for Control

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 Control

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