Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListEntityTypesRequest.
Request message for FeaturestoreService.ListEntityTypes.
Generated from protobuf message google.cloud.aiplatform.v1.ListEntityTypesRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the Featurestore to list EntityTypes. Format: |
↳ filter |
string
Lists the EntityTypes that match the filter expression. The following filters are supported: * |
↳ page_size |
int
The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes 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.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes 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. |
getParent
Required. The resource name of the Featurestore to list EntityTypes.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The resource name of the Featurestore to list EntityTypes.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Lists the EntityTypes that match the filter expression. The following filters are supported:
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: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
--> EntityTypes having both (active: yes) and (env: prod) labels.labels.env: *
--> Any EntityType which has a label with 'env' as the key.
Generated from protobuf field string filter = 2;
Returns | |
---|---|
Type | Description |
string |
setFilter
Lists the EntityTypes that match the filter expression. The following filters are supported:
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: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
--> EntityTypes having both (active: yes) and (env: prod) labels.labels.env: *
--> Any EntityType which has a label with 'env' as the key.
Generated from protobuf field string filter = 2;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned.
The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Generated from protobuf field int32 page_size = 3;
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned.
The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Generated from protobuf field int32 page_size = 3;
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
A page token, received from a previous FeaturestoreService.ListEntityTypes call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.
Generated from protobuf field string page_token = 4;
Returns | |
---|---|
Type | Description |
string |
setPageToken
A page token, received from a previous FeaturestoreService.ListEntityTypes call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.
Generated from protobuf field string page_token = 4;
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:
entity_type_id
create_time
update_time
Generated from protobuf field string order_by = 5;
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:
entity_type_id
create_time
update_time
Generated from protobuf field string order_by = 5;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasReadMask
clearReadMask
setReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |