Method: projects.locations.featurestores.entityTypes.features.list

Lists Features in a given EntityType.

HTTP request

GET https://{service-endpoint}/v1/{parent}/features

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the Location to list Features. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

Query parameters

Parameters
filter

string

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

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

Examples:

  • valueType = DOUBLE --> Features whose type is DOUBLE.
  • createTime > \"2020-01-31T15:30:00.000000Z\" OR updateTime > \"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.
pageSize

integer

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.

pageToken

string

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

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

orderBy

string

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

  • featureId
  • valueType
  • createTime
  • updateTime
readMask

string (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

latestStatsCount

integer

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for FeaturestoreService.ListFeatures.

JSON representation
{
  "features": [
    {
      object (Feature)
    }
  ],
  "nextPageToken": string
}
Fields
features[]

object (Feature)

The Features matching the request.

nextPageToken

string

A token, which can be sent as ListFeaturesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.features.list

For more information, see the IAM documentation.