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: display_name = "test".
Supported fields include: name, display_name, schema_title,
create_time, and update_time.
Time fields, such as create_time and update_time, require values
specified in RFC-3339 format.
For example: create_time = "2020-11-19T11:30:00-04:00".
Metadata field:
To filter on metadata fields use traversal operation as follows:
metadata.<field_name>.<type_value>.
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:
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.
A page token, received from a previous
[MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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.)
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003e\u003ccode\u003eListContextsRequest\u003c/code\u003e is a class within the Vertex AI v1beta1 API, designed to request a list of contexts from the MetadataService.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIPageRequest\u003c/code\u003e, indicating its capabilities for message handling, comparison, cloning, and pagination.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eListContextsRequest\u003c/code\u003e include \u003ccode\u003eFilter\u003c/code\u003e, which allows for querying based on attribute and metadata fields, \u003ccode\u003eOrderBy\u003c/code\u003e, for specifying the order of the results, \u003ccode\u003ePageSize\u003c/code\u003e, to limit the number of results returned, and \u003ccode\u003eParent\u003c/code\u003e, to specify the metadata store to get the list from.\u003c/p\u003e\n"],["\u003cp\u003eThe class can be used to filter contexts by parent-child relationships, metadata fields and attributes, using logical operators such as AND and OR.\u003c/p\u003e\n"],["\u003cp\u003eIt has two constructors: one default and one that accepts a \u003ccode\u003eListContextsRequest\u003c/code\u003e object for cloning purposes.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class ListContextsRequest (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest) \n\n public sealed class ListContextsRequest : IMessage\u003cListContextsRequest\u003e, IEquatable\u003cListContextsRequest\u003e, IDeepCloneable\u003cListContextsRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Vertex AI v1beta1 API class ListContextsRequest.\n\nRequest message for\n\\[MetadataService.ListContexts\\]\\[google.cloud.aiplatform.v1beta1.MetadataService.ListContexts\\] \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListContextsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListContextsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListContextsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListContextsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### ListContextsRequest()\n\n public ListContextsRequest()\n\n### ListContextsRequest(ListContextsRequest)\n\n public ListContextsRequest(ListContextsRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nFilter specifying the boolean condition for the Contexts to satisfy in\norder to be part of the result set.\nThe syntax to define filter query is based on \u003chttps://google.aip.dev/160\u003e.\nFollowing are the supported set of filters:\n\n- **Attribute filtering** : For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`.\n- **Metadata field** : To filter on metadata fields use traversal operation as follows: `metadata.\u003cfield_name\u003e.\u003ctype_value\u003e`. 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`\n- **Parent Child filtering**:\n To filter Contexts based on parent-child relationship use the HAS\n operator as follows:\n\n parent_contexts:\n \"projects/\u003cproject_number\u003e/locations/\u003clocation\u003e/metadataStores/\u003cmetadatastore_name\u003e/contexts/\u003ccontext_id\u003e\"\n child_contexts:\n \"projects/\u003cproject_number\u003e/locations/\u003clocation\u003e/metadataStores/\u003cmetadatastore_name\u003e/contexts/\u003ccontext_id\u003e\"\n\nEach of the above supported filters can be combined together using\nlogical operators (`AND` \\& `OR`). Maximum nested expression depth allowed\nis 5.\n\nFor example: `display_name = \"test\" AND metadata.field1.bool_value = true`.\n\n### OrderBy\n\n public string OrderBy { get; set; }\n\nHow the list of messages is ordered. Specify the values to order by and an\nordering operation. The default sorting order is ascending. To specify\ndescending order for a field, users append a \" desc\" suffix; for example:\n\"foo desc, bar\".\nSubfields are specified with a `.` character, such as foo.bar.\nsee \u003chttps://google.aip.dev/132#ordering\u003e for more details.\n\n### PageSize\n\n public int PageSize { get; set; }\n\nThe maximum number of Contexts to return. The service may return fewer.\nMust be in range 1-1000, inclusive. Defaults to 100.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nA page token, received from a previous\n\\[MetadataService.ListContexts\\]\\[google.cloud.aiplatform.v1beta1.MetadataService.ListContexts\\]\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other provided parameters must match the call that\nprovided the page token. (Otherwise the request will fail with\nINVALID_ARGUMENT error.)\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The MetadataStore whose Contexts should be listed.\nFormat:\n`projects/{project}/locations/{location}/metadataStores/{metadatastore}`\n\n### ParentAsMetadataStoreName\n\n public MetadataStoreName ParentAsMetadataStoreName { get; set; }\n\n[MetadataStoreName](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.MetadataStoreName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListContextsRequest#Google_Cloud_AIPlatform_V1Beta1_ListContextsRequest_Parent) resource name property."]]
