Method: projects.locations.metadataStores.contexts.list

Lists contexts on the MetadataStore.

Endpoint

get https://{endpoint}/v1/{parent}/contexts

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

Path parameters

parent string

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

Query 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>.<typeValue>. For example: metadata.field_1.number_value = 10.0. In case the field name contains special characters (such as colon), one can embed it inside double quote. 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). Maximum nested expression depth allowed is 5.

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

orderBy string

How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

Request body

The request body must be empty.

Response body

Response message for MetadataService.ListContexts.

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

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.

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