Method: projects.locations.metadataStores.contexts.list

Lists Contexts on the MetadataStore.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/contexts

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

Path parameters

Parameters
parent

string

Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Query parameters

Parameters
pageSize

integer

The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

pageToken

string

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

When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)

filter

string

Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters:

  • Attribute filtering: For example: displayName = "test". Supported fields include: name, displayName, schemaTitle, createTime, and updateTime. Time fields, such as createTime and updateTime, require values specified in RFC-3339 format. For example: createTime = "2020-11-19T11:30:00-04:00".
  • Metadata field: To filter on metadata fields use traversal operation as follows: metadata.<fieldName>.<type_value>. For example: metadata.field_1.number_value = 10.0.
  • Parent Child filtering: To filter Contexts based on parent-child relationship use the HAS operator as follows:

parentContexts: "projects/<projectNumber>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<contextId>" childContexts: "projects/<projectNumber>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<contextId>"

Each of the above supported filters can be combined together using logical operators (AND & OR).

For example: displayName = "test" AND metadata.field1.bool_value = true.

Request body

The request body must be empty.

Response body

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

Response message for MetadataService.ListContexts.

JSON representation
{
  "contexts": [
    {
      object (Context)
    }
  ],
  "nextPageToken": string
}
Fields
contexts[]

object (Context)

The Contexts retrieved from the MetadataStore.

nextPageToken

string

A token, which can be sent as ListContextsRequest.page_token to retrieve the next page. If this field is not populated, 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.contexts.list

For more information, see the IAM documentation.