Method: projects.locations.featurestores.list

Lists Featurestores in a given project and location.

HTTP request

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

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

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
filter

string

Lists the featurestores that match the filter expression. The following fields are supported:

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

Examples:

  • createTime > "2020-01-01" OR updateTime > "2020-01-01" Featurestores created or updated after 2020-01-01.
  • labels.env = "prod" Featurestores with label "env" set to "prod".
pageSize

integer

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

pageToken

string

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

When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores 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:

  • createTime
  • updateTime
  • onlineServingConfig.fixed_node_count
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".

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.ListFeaturestores.

JSON representation
{
  "featurestores": [
    {
      object (Featurestore)
    }
  ],
  "nextPageToken": string
}
Fields
featurestores[]

object (Featurestore)

The Featurestores matching the request.

nextPageToken

string

A token, which can be sent as ListFeaturestoresRequest.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.featurestores.list

For more information, see the IAM documentation.