Struct SearchNearestEntitiesRequest

#[non_exhaustive]
pub struct SearchNearestEntitiesRequest {
    pub feature_view: String,
    pub query: Option<NearestNeighborQuery>,
    pub return_full_entity: bool,
    /* private fields */
}

The request message for FeatureOnlineStoreService.SearchNearestEntities.

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.

feature_view: String

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

query: Option<NearestNeighborQuery>

Required. The query.

return_full_entity: bool

Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.

Implementations

impl SearchNearestEntitiesRequest

pub fn new() -> Self

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

Sets the value of feature_view.

pub fn set_query<T: Into<Option<NearestNeighborQuery>>>(self, v: T) -> Self

Sets the value of query.

pub fn set_return_full_entity<T: Into<bool>>(self, v: T) -> Self

Sets the value of return_full_entity.

Trait Implementations

impl Clone for SearchNearestEntitiesRequest

fn clone(&self) -> SearchNearestEntitiesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchNearestEntitiesRequest

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

Formats the value using the given formatter.

impl Default for SearchNearestEntitiesRequest

fn default() -> SearchNearestEntitiesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchNearestEntitiesRequest

where SearchNearestEntitiesRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SearchNearestEntitiesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchNearestEntitiesRequest

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchNearestEntitiesRequest