- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.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
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 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.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListContextsRequest.
Request message for MetadataService.ListContexts
Generated from protobuf message google.cloud.aiplatform.v1.ListContextsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
↳ page_size
int
The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
↳ page_token
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: 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: 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
.
↳ order_by
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.
getParent
Required. The MetadataStore whose Contexts should be listed.
Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
string
setParent
Required. The MetadataStore whose Contexts should be listed.
Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
var
string
$this
getPageSize
The maximum number of Contexts to return. The service may return fewer.
Must be in range 1-1000, inclusive. Defaults to 100.
int
setPageSize
The maximum number of Contexts to return. The service may return fewer.
Must be in range 1-1000, inclusive. Defaults to 100.
var
int
$this
getPageToken
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
setPageToken
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.)
var
string
$this
getFilter
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_timeandupdate_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:
php 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.
string
setFilter
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_timeandupdate_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:
php 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.
var
string
$this
getOrderBy
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
setOrderBy
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.
var
string
$this
static::build
parent
string
Required. The MetadataStore whose Contexts should be listed.
Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
Please see Google\Cloud\AIPlatform\V1\MetadataServiceClient::metadataStoreName()
for help formatting this field.
