Struct Control 

#[non_exhaustive]
pub struct Control {
    pub name: String,
    pub display_name: String,
    pub associated_serving_config_ids: Vec<String>,
    pub solution_types: Vec<SolutionType>,
    pub search_solution_use_case: Vec<SearchSolutionUseCase>,
    pub control: Option<Control>,
    /* private fields */
}

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

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

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

display_name: String

Required. The human readable control display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

associated_serving_config_ids: Vec<String>

Output only. List of serving config ids that are associated with this control in the same Catalog.

Note the association is managed via the ServingConfig, this is an output only denormalized view.

solution_types: Vec<SolutionType>

Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time.

Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

search_solution_use_case: Vec<SearchSolutionUseCase>

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

control: Option<Control>

The behavior/type of the control

A behavior/type must be specified on creation. Type cannot be changed once specified (e.g. A Rule control will always be a Rule control.). An INVALID_ARGUMENT will be returned if either condition is violated.

Implementations

impl Control

pub fn new() -> Self

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

Sets the value of name.

Example

let x = Control::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 = Control::new().set_display_name("example");

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of associated_serving_config_ids.

Example

let x = Control::new().set_associated_serving_config_ids(["a", "b", "c"]);

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

where T: IntoIterator<Item = V>, V: Into<SolutionType>,

Sets the value of solution_types.

Example

use google_cloud_retail_v2::model::SolutionType;
let x = Control::new().set_solution_types([
    SolutionType::Recommendation,
    SolutionType::Search,
]);

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

where T: IntoIterator<Item = V>, V: Into<SearchSolutionUseCase>,

Sets the value of search_solution_use_case.

Example

use google_cloud_retail_v2::model::SearchSolutionUseCase;
let x = Control::new().set_search_solution_use_case([
    SearchSolutionUseCase::Search,
    SearchSolutionUseCase::Browse,
]);

pub fn set_control<T: Into<Option<Control>>>(self, v: T) -> Self

Sets the value of control.

Note that all the setters affecting control are mutually exclusive.

Example

use google_cloud_retail_v2::model::Rule;
let x = Control::new().set_control(Some(
    google_cloud_retail_v2::model::control::Control::Rule(Rule::default().into())));

pub fn rule(&self) -> Option<&Box<Rule>>

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

pub fn set_rule<T: Into<Box<Rule>>>(self, v: T) -> Self

Sets the value of control to hold a Rule.

Note that all the setters affecting control are mutually exclusive.

Example

use google_cloud_retail_v2::model::Rule;
let x = Control::new().set_rule(Rule::default()/* use setters */);
assert!(x.rule().is_some());

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a duplicate 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() -> Control

Returns the “default value” for a type.

impl Message for Control

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Control

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