Struct CustomAttribute 

#[non_exhaustive]
pub struct CustomAttribute {
    pub text: Vec<String>,
    pub numbers: Vec<f64>,
    pub searchable: Option<bool>,
    pub indexable: Option<bool>,
    /* private fields */
}

A custom attribute that is not explicitly modeled in Product.

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.

text: Vec<String>

The textual values of this custom attribute. For example, ["yellow", "green"] when the key is “color”.

Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

numbers: Vec<f64>

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is “lengths_cm”.

Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

searchable: Option<bool>

👎Deprecated

This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated ‘PRODUCT_LEVEL_ATTRIBUTE_CONFIG’ mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are searchable by text queries in SearchService.Search.

This field is ignored in a UserEvent.

Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.

indexable: Option<bool>

👎Deprecated

This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated ‘PRODUCT_LEVEL_ATTRIBUTE_CONFIG’ mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search.

This field is ignored in a UserEvent.

See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.

Implementations

impl CustomAttribute

pub fn new() -> Self

Creates a new default instance.

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

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

Sets the value of text.

Example

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

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

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

Sets the value of numbers.

Example

let x = CustomAttribute::new().set_numbers([1.0, 2.0, 3.0]);

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

where T: Into<bool>,

👎Deprecated

Sets the value of searchable.

Example

let x = CustomAttribute::new().set_searchable(true);

pub fn set_or_clear_searchable<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

👎Deprecated

Sets or clears the value of searchable.

Example

let x = CustomAttribute::new().set_or_clear_searchable(Some(false));
let x = CustomAttribute::new().set_or_clear_searchable(None::<bool>);

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

where T: Into<bool>,

👎Deprecated

Sets the value of indexable.

Example

let x = CustomAttribute::new().set_indexable(true);

pub fn set_or_clear_indexable<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

👎Deprecated

Sets or clears the value of indexable.

Example

let x = CustomAttribute::new().set_or_clear_indexable(Some(false));
let x = CustomAttribute::new().set_or_clear_indexable(None::<bool>);

Trait Implementations

impl Clone for CustomAttribute

fn clone(&self) -> CustomAttribute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomAttribute

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

Formats the value using the given formatter.

impl Default for CustomAttribute

fn default() -> CustomAttribute

Returns the “default value” for a type.

impl Message for CustomAttribute

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CustomAttribute

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CustomAttribute