- 3.12.0 (latest)
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public sealed class ListContextsRequest : IMessage<ListContextsRequest>, IEquatable<ListContextsRequest>, IDeepCloneable<ListContextsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Cloud AI Platform v1 API class ListContextsRequest.
Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
Implements
IMessageListContextsRequest, IEquatableListContextsRequest, IDeepCloneableListContextsRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
ListContextsRequest()
public ListContextsRequest()
ListContextsRequest(ListContextsRequest)
public ListContextsRequest(ListContextsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListContextsRequest |
Properties
Filter
public string Filter { get; set; }
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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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:
parent_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>" child_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
Each of the above supported filters can be combined together using
logical operators (AND
& OR
). Maximum nested expression depth allowed
is 5.
For example: display_name = "test" AND metadata.field1.bool_value = true
.
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1.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.)
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The MetadataStore whose Contexts should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
Property Value | |
---|---|
Type | Description |
string |
ParentAsMetadataStoreName
public MetadataStoreName ParentAsMetadataStoreName { get; set; }
MetadataStoreName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
MetadataStoreName |