Struct gapi_grpc::google::cloud::aiplatform::v1beta1::SearchFeaturesRequest

pub struct SearchFeaturesRequest {
    pub location: String,
    pub query: String,
    pub page_size: i32,
    pub page_token: String,
}

Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures].

Fields

location: String

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

query: String

Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using AND to form a conjunction.

A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature’s FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by:

• Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric [a-zA-Z0-9], underscore [_], or asterisk [] are treated as delimiters for tokens. () is treated as a wildcard that matches characters within a token.
• Ignoring case.
• Prepending an asterisk to the first and appending an asterisk to the last token in QUERY.

A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (“). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively.

Supported FIELDs for field-restricted queries:

• feature_id
• description
• entity_type_id

Examples:

• feature_id: foo –> Matches a Feature with ID containing the substring foo (eg. foo, foofeature, barfoo).
• feature_id: foo*feature –> Matches a Feature with ID containing the substring foo*feature (eg. foobarfeature).
• feature_id: foo AND description: bar –> Matches a Feature with ID containing the substring foo and description containing the substring bar.

Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive.

• feature_id: Supports = comparisons.
• description: Supports = comparisons. Multi-token filters should be enclosed in quotes.
• entity_type_id: Supports = comparisons.
• value_type: Supports = and != comparisons.
• labels: Supports key-value equality as well as key presence.
• featurestore_id: Supports = comparisons.

Examples:

• description = "foo bar" –> Any Feature with description exactly equal to foo bar
• value_type = DOUBLE –> Features whose type is DOUBLE.
• labels.active = yes AND labels.env = prod –> Features having both (active: yes) and (env: prod) labels.
• labels.env: * –> Any Feature which has a label with env as the key.

page_size: i32

The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

page_token: String

A page token, received from a previous [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures], except page_size, must match the call that provided the page token.

Trait Implementations

impl Clone for SearchFeaturesRequest

fn clone(&self) -> SearchFeaturesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFeaturesRequest

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

Formats the value using the given formatter.

impl Default for SearchFeaturesRequest

fn default() -> SearchFeaturesRequest

Returns the “default value” for a type.

impl Message for SearchFeaturesRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<SearchFeaturesRequest> for SearchFeaturesRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for SearchFeaturesRequest