Struct DataStoreSpec 

#[non_exhaustive]
pub struct DataStoreSpec {
    pub data_store: String,
    pub filter: String,
    pub boost_spec: Option<BoostSpec>,
    pub custom_search_operators: String,
    /* private fields */
}

Available on crate features assistant-service or conversational-search-service or search-service or serving-config-service only.

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

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.

data_store: String

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

filter: String

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

boost_spec: Option<BoostSpec>

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

custom_search_operators: String

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

Implementations

impl DataStoreSpec

pub fn new() -> Self

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

Sets the value of data_store.

Example

let x = DataStoreSpec::new().set_data_store("example");

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

Sets the value of filter.

Example

let x = DataStoreSpec::new().set_filter("example");

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

where T: Into<BoostSpec>,

Sets the value of boost_spec.

Example

use google_cloud_discoveryengine_v1::model::search_request::BoostSpec;
let x = DataStoreSpec::new().set_boost_spec(BoostSpec::default()/* use setters */);

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

where T: Into<BoostSpec>,

Sets or clears the value of boost_spec.

Example

use google_cloud_discoveryengine_v1::model::search_request::BoostSpec;
let x = DataStoreSpec::new().set_or_clear_boost_spec(Some(BoostSpec::default()/* use setters */));
let x = DataStoreSpec::new().set_or_clear_boost_spec(None::<BoostSpec>);

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

Sets the value of custom_search_operators.

Example

let x = DataStoreSpec::new().set_custom_search_operators("example");

Trait Implementations

impl Clone for DataStoreSpec

fn clone(&self) -> DataStoreSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataStoreSpec

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

Formats the value using the given formatter.

impl Default for DataStoreSpec

fn default() -> DataStoreSpec

Returns the “default value” for a type.

impl Message for DataStoreSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DataStoreSpec

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