Struct BoostAction 

#[non_exhaustive]
pub struct BoostAction {
    pub boost: f32,
    pub filter: String,
    pub data_store: String,
    pub boost_spec: Option<BoostSpec>,
    /* private fields */
}

Available on crate feature control-service only.

Adjusts order of products in returned list.

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.

boost: f32

👎Deprecated

Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

filter: String

Required. Specifies which products to apply the boost to.

If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

data_store: String

Required. Specifies which data store’s documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

boost_spec: Option<BoostSpec>

Constant value boost or custom ranking based boost specifications.

Implementations

impl BoostAction

pub fn new() -> Self

Creates a new default instance.

pub fn set_boost<T: Into<f32>>(self, v: T) -> Self

👎Deprecated

Sets the value of boost.

Example

let x = BoostAction::new().set_boost(42.0);

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

Sets the value of filter.

Example

let x = BoostAction::new().set_filter("example");

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

Sets the value of data_store.

Example

let x = BoostAction::new().set_data_store(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}"));

pub fn set_boost_spec<T: Into<Option<BoostSpec>>>(self, v: T) -> Self

Sets the value of boost_spec.

Note that all the setters affecting boost_spec are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::control::boost_action::BoostSpec;
let x = BoostAction::new().set_boost_spec(Some(BoostSpec::FixedBoost(42.0)));

pub fn fixed_boost(&self) -> Option<&f32>

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

pub fn set_fixed_boost<T: Into<f32>>(self, v: T) -> Self

Sets the value of boost_spec to hold a FixedBoost.

Note that all the setters affecting boost_spec are mutually exclusive.

Example

let x = BoostAction::new().set_fixed_boost(42.0);
assert!(x.fixed_boost().is_some());
assert!(x.interpolation_boost_spec().is_none());

pub fn interpolation_boost_spec(&self) -> Option<&Box<InterpolationBoostSpec>>

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

pub fn set_interpolation_boost_spec<T: Into<Box<InterpolationBoostSpec>>>( self, v: T, ) -> Self

Sets the value of boost_spec to hold a InterpolationBoostSpec.

Note that all the setters affecting boost_spec are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::control::boost_action::InterpolationBoostSpec;
let x = BoostAction::new().set_interpolation_boost_spec(InterpolationBoostSpec::default()/* use setters */);
assert!(x.interpolation_boost_spec().is_some());
assert!(x.fixed_boost().is_none());

Trait Implementations

impl Clone for BoostAction

fn clone(&self) -> BoostAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoostAction

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

Formats the value using the given formatter.

impl Default for BoostAction

fn default() -> BoostAction

Returns the “default value” for a type.

impl Message for BoostAction

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BoostAction

fn eq(&self, other: &BoostAction) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BoostAction