Struct TextSearch 

#[non_exhaustive]
pub struct TextSearch {
    pub search_text: String,
    pub data_field_names: Vec<String>,
    pub output_fields: Option<OutputFields>,
    pub top_k: Option<i32>,
    pub filter: Option<Struct>,
    /* private fields */
}

Defines a text search operation.

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.

search_text: String

Required. The query text.

data_field_names: Vec<String>

Required. The data field names to search.

output_fields: Option<OutputFields>

Optional. The fields to return in the search results.

top_k: Option<i32>

Optional. The number of results to return.

filter: Option<Struct>

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

Implementations

impl TextSearch

pub fn new() -> Self

pub fn set_search_text<T: Into<String>>(self, v: T) -> Self

Sets the value of search_text.

Example

let x = TextSearch::new().set_search_text("example");

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

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

Sets the value of data_field_names.

Example

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

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

where T: Into<OutputFields>,

Sets the value of output_fields.

Example

use google_cloud_vectorsearch_v1::model::OutputFields;
let x = TextSearch::new().set_output_fields(OutputFields::default()/* use setters */);

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

where T: Into<OutputFields>,

Sets or clears the value of output_fields.

Example

use google_cloud_vectorsearch_v1::model::OutputFields;
let x = TextSearch::new().set_or_clear_output_fields(Some(OutputFields::default()/* use setters */));
let x = TextSearch::new().set_or_clear_output_fields(None::<OutputFields>);

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

where T: Into<i32>,

Sets the value of top_k.

Example

let x = TextSearch::new().set_top_k(42);

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

where T: Into<i32>,

Sets or clears the value of top_k.

Example

let x = TextSearch::new().set_or_clear_top_k(Some(42));
let x = TextSearch::new().set_or_clear_top_k(None::<i32>);

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

where T: Into<Struct>,

Sets the value of filter.

Example

use wkt::Struct;
let x = TextSearch::new().set_filter(Struct::default()/* use setters */);

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

where T: Into<Struct>,

Sets or clears the value of filter.

Example

use wkt::Struct;
let x = TextSearch::new().set_or_clear_filter(Some(Struct::default()/* use setters */));
let x = TextSearch::new().set_or_clear_filter(None::<Struct>);

Trait Implementations

impl Clone for TextSearch

fn clone(&self) -> TextSearch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextSearch

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

Formats the value using the given formatter.

impl Default for TextSearch

fn default() -> TextSearch

Returns the “default value” for a type.

impl Message for TextSearch

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TextSearch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TextSearch