Struct google_api_proto::google::cloud::retail::v2beta::CustomAttribute

pub struct CustomAttribute {
    pub text: Vec<String>,
    pub numbers: Vec<f64>,
    pub searchable: Option<bool>,
    pub indexable: Option<bool>,
}

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2beta.Product].

Fields

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][google.cloud.retail.v2beta.CustomAttribute.text] or [numbers][google.cloud.retail.v2beta.CustomAttribute.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][google.cloud.retail.v2beta.CustomAttribute.text] or [numbers][google.cloud.retail.v2beta.CustomAttribute.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][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] of the [Catalog][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2beta.UserEvent].

Only set if type [text][google.cloud.retail.v2beta.CustomAttribute.text] is set. Otherwise, a INVALID_ARGUMENT error is returned.

indexable: Option<bool>

👎Deprecated

This field is normally ignored unless [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] of the [Catalog][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2beta.UserEvent].

See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter], [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] for more details.

Implementations

impl CustomAttribute

pub fn searchable(&self) -> bool

Returns the value of searchable, or the default value if searchable is unset.

pub fn indexable(&self) -> bool

Returns the value of indexable, or the default value if indexable is unset.

Trait Implementations

impl Clone for CustomAttribute

fn clone(&self) -> CustomAttribute

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for CustomAttribute

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 CustomAttribute

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