Enum google_api_proto::google::cloud::retail::v2alpha::search_request::SearchMode

#[repr(i32)]
pub enum SearchMode {
    Unspecified = 0,
    ProductSearchOnly = 1,
    FacetedSearchOnly = 2,
}

The search mode of each search request.

Variants

Unspecified = 0

Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] and [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] will be returned.

ProductSearchOnly = 1

Only product search will be performed. The faceted search will be disabled.

Only [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] will be returned. [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] will not be returned, even if [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs] or [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec] is set.

FacetedSearchOnly = 2

Only faceted search will be performed. The product search will be disabled.

When in this mode, one or both of [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs] and [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec] should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] will be returned. [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] will not be returned.

Implementations

impl SearchMode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SearchMode.

pub fn from_i32(value: i32) -> Option<SearchMode>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a SearchMode, or None if value is not a valid variant.

impl SearchMode

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for SearchMode

fn clone(&self) -> SearchMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchMode

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

Formats the value using the given formatter.

impl Default for SearchMode

fn default() -> SearchMode

Returns the “default value” for a type.

impl From<SearchMode> for i32

fn from(value: SearchMode) -> i32

Converts to this type from the input type.

impl Hash for SearchMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SearchMode

fn cmp(&self, other: &SearchMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SearchMode

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

fn partial_cmp(&self, other: &SearchMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for SearchMode

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<SearchMode, UnknownEnumValue>

Performs the conversion.

impl Copy for SearchMode

impl Eq for SearchMode

impl StructuralPartialEq for SearchMode