- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListContextsRequest.
Request message for MetadataService.ListContexts
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::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:
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
. - 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
).For example:
display_name = "test" AND metadata.field1.bool_value = true
. - Attribute filtering:
For example:
#filter=
def filter=(value) -> ::String
-
value (::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:
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
. - 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
).For example:
display_name = "test" AND metadata.field1.bool_value = true
. - Attribute filtering:
For example:
-
(::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:
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
. - 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
).For example:
display_name = "test" AND metadata.field1.bool_value = true
. - Attribute filtering:
For example:
#order_by
def order_by() -> ::String
-
(::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.
#order_by=
def order_by=(value) -> ::String
-
value (::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.
-
(::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.
#page_size
def page_size() -> ::Integer
- (::Integer) — The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
- (::Integer) — The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
#page_token
def page_token() -> ::String
-
(::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.)
#page_token=
def page_token=(value) -> ::String
-
value (::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.)
-
(::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.)
#parent
def parent() -> ::String
-
(::String) — Required. The MetadataStore whose Contexts should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
#parent=
def parent=(value) -> ::String
-
value (::String) — Required. The MetadataStore whose Contexts should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
-
(::String) — Required. The MetadataStore whose Contexts should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}