Struct ListFeaturesRequest

#[non_exhaustive]
pub struct ListFeaturesRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
    pub read_mask: Option<FieldMask>,
    pub latest_stats_count: i32,
    /* private fields */
}

Request message for FeaturestoreService.ListFeatures. Request message for FeatureRegistryService.ListFeatures.

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.

parent: String

Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

filter: String

Lists the Features that match the filter expression. The following filters are supported:

• value_type: Supports = and != comparisons.
• create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
• update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
• labels: Supports key-value equality as well as key presence.

Examples:

• value_type = DOUBLE –> Features whose type is DOUBLE.
• create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\" –> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.
• 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 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

page_token: String

A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.

order_by: String

A comma-separated list of fields to order by, sorted in ascending order. Use “desc” after a field name for descending. Supported fields:

• feature_id
• value_type (Not supported for FeatureRegistry Feature)
• create_time
• update_time

read_mask: Option<FieldMask>

Mask specifying which fields to read.

latest_stats_count: i32

Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

Implementations

impl ListFeaturesRequest

pub fn new() -> Self

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

Sets the value of parent.

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

Sets the value of filter.

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

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

Sets the value of page_token.

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

Sets the value of order_by.

pub fn set_read_mask<T: Into<Option<FieldMask>>>(self, v: T) -> Self

Sets the value of read_mask.

pub fn set_latest_stats_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of latest_stats_count.

Trait Implementations

impl Clone for ListFeaturesRequest

fn clone(&self) -> ListFeaturesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListFeaturesRequest

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

Formats the value using the given formatter.

impl Default for ListFeaturesRequest

fn default() -> ListFeaturesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListFeaturesRequest

where ListFeaturesRequest: 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 ListFeaturesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListFeaturesRequest

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

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 ListFeaturesRequest