Struct googapis::google::cloud::retail::v2alpha::search_request::FacetSpec

pub struct FacetSpec {
    pub facet_key: Option<FacetKey>,
    pub limit: i32,
    pub excluded_filter_keys: Vec<String>,
    pub enable_dynamic_position: bool,
}

A facet specification to perform faceted search.

Fields

facet_key: Option<FacetKey>

Required. The facet key specification.

limit: i32

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300.

If this field is negative, an INVALID_ARGUMENT is returned.

excluded_filter_keys: Vec<String>

List of keys to exclude when faceting.

By default, [FacetKey.key][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.key] is not excluded from the filter unless it is listed in this field.

For example, suppose there are 100 products with color facet “Red” and 200 products with color facet “Blue”. A query containing the filter “colorFamilies:ANY(“Red”)“ and have “colorFamilies” as [FacetKey.key][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.key] will by default return the “Red” with count 100.

If this field contains “colorFamilies”, then the query returns both the “Red” with count 100 and “Blue” with count 200, because the “colorFamilies” key is now excluded from the filter.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

enable_dynamic_position: bool

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets.

For example, you may always want to have rating facet returned in the response, but it’s not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search.

Another example, assuming you have the following facets in the request:

• “rating”, enable_dynamic_position = true

• “price”, enable_dynamic_position = false

• “brands”, enable_dynamic_position = false

And also you have a dynamic facets enable, which will generate a facet ‘gender’. Then the final order of the facets in the response can be (“price”, “brands”, “rating”, “gender”) or (“price”, “brands”, “gender”, “rating”) depends on how Google Retail Search orders “gender” and “rating” facets. However, notice that “price” and “brands” will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

Trait Implementations

impl Clone for FacetSpec

fn clone(&self) -> FacetSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FacetSpec

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

Formats the value using the given formatter.

impl Default for FacetSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for FacetSpec

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<FacetSpec> for FacetSpec

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for FacetSpec