Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListFeaturesRequest.
Request message for FeaturestoreService.ListFeatures.
Generated from protobuf message google.cloud.aiplatform.v1.ListFeaturesRequest
Methods
build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to list Features.
Format:
|
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ListFeaturesRequest |
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the Location to list Features. Format: |
↳ filter |
string
Lists the Features that match the filter expression. The following filters are supported: * |
↳ page_size |
int
The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. |
↳ page_token |
string
A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token. |
↳ order_by |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * |
↳ read_mask |
Google\Protobuf\FieldMask
Mask specifying which fields to read. |
↳ latest_stats_count |
int
If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. |
getParent
Required. The resource name of the Location to list Features.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The resource name of the Location to list Features.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Lists the Features that match the filter expression. The following filters are supported:
value_type
: Supports = and != comparisons.create_time
: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.update_time
: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.labels
: Supports key-value equality as well as key presence. Examples:value_type = DOUBLE
--> Features whose type is DOUBLE.create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"
--> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.labels.active = yes AND labels.env = prod
--> Features having both (active: yes) and (env: prod) labels.labels.env: *
--> Any Feature which has a label with 'env' as the key.
Returns | |
---|---|
Type | Description |
string |
setFilter
Lists the Features that match the filter expression. The following filters are supported:
value_type
: Supports = and != comparisons.create_time
: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.update_time
: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.labels
: Supports key-value equality as well as key presence. Examples:value_type = DOUBLE
--> Features whose type is DOUBLE.create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"
--> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.labels.active = yes AND labels.env = prod
--> Features having both (active: yes) and (env: prod) labels.labels.env: *
--> Any Feature which has a label with 'env' as the key.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned.
The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned.
The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token.
Returns | |
---|---|
Type | Description |
string |
setPageToken
A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending. Supported fields:
feature_id
value_type
create_time
update_time
Returns | |
---|---|
Type | Description |
string |
setOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending. Supported fields:
feature_id
value_type
create_time
update_time
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadMask
Mask specifying which fields to read.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasReadMask
clearReadMask
setReadMask
Mask specifying which fields to read.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getLatestStatsCount
If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Returns | |
---|---|
Type | Description |
int |
setLatestStatsCount
If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |