Cloud AI Platform v1 API - Class ListFeaturesRequest (2.28.0) 

public sealed class ListFeaturesRequest : IPageRequest, IMessage<ListFeaturesRequest>, IEquatable<ListFeaturesRequest>, IDeepCloneable<ListFeaturesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class ListFeaturesRequest.

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

Inheritance

object > ListFeaturesRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListFeaturesRequest()

public ListFeaturesRequest()

ListFeaturesRequest(ListFeaturesRequest)

public ListFeaturesRequest(ListFeaturesRequest other)
Parameter
Name Description
other ListFeaturesRequest

Properties

Filter

public string Filter { get; set; }

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.
Property Value
Type Description
string

LatestStatsCount

public int LatestStatsCount { get; set; }

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.

Property Value
Type Description
int

OrderBy

public string OrderBy { get; set; }

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
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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}

Property Value
Type Description
string

ParentAsEntityTypeName

public EntityTypeName ParentAsEntityTypeName { get; set; }

EntityTypeName-typed view over the Parent resource name property.

Property Value
Type Description
EntityTypeName

ParentAsFeatureGroupName

public FeatureGroupName ParentAsFeatureGroupName { get; set; }

FeatureGroupName-typed view over the Parent resource name property.

Property Value
Type Description
FeatureGroupName

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
Type Description
IResourceName

ReadMask

public FieldMask ReadMask { get; set; }

Mask specifying which fields to read.

Property Value
Type Description
FieldMask