Struct google_api_proto::google::cloud::aiplatform::v1::ListFeaturesRequest

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,
}

Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. Request message for [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].

Fields

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][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] call or [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] or [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count], return all existing stats.

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() -> Self

Returns the “default value” for a type.

impl Message for ListFeaturesRequest

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.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for ListFeaturesRequest

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

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

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

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

impl StructuralPartialEq for ListFeaturesRequest