Enum google_api_proto::google::cloud::discoveryengine::v1::search_request::content_search_spec::SearchResultMode

#[repr(i32)]
pub enum SearchResultMode {
    Unspecified = 0,
    Documents = 1,
    Chunks = 2,
}

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

Variants

Unspecified = 0

Default value.

Documents = 1

Returns documents in the search result.

Chunks = 2

Returns chunks in the search result. Only available if the [DataStore.DocumentProcessingConfig.chunking_config][] is specified.

Implementations

impl SearchResultMode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SearchResultMode.

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

👎Deprecated: Use the TryFrom<i32> implementation instead

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

impl SearchResultMode

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 SearchResultMode

fn clone(&self) -> SearchResultMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResultMode

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

Formats the value using the given formatter.

impl Default for SearchResultMode

fn default() -> SearchResultMode

Returns the “default value” for a type.

impl From<SearchResultMode> for i32

fn from(value: SearchResultMode) -> i32

Converts to this type from the input type.

impl Hash for SearchResultMode

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 SearchResultMode

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

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

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

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for SearchResultMode

impl Eq for SearchResultMode

impl StructuralPartialEq for SearchResultMode