Lists EntityTypes in a given Featurestore.
HTTP request
GET https://{service-endpoint}/v1/{parent}/entityTypes
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Featurestore to list EntityTypes. Format: |
Query parameters
Parameters | |
---|---|
filter |
Lists the EntityTypes that match the filter expression. The following filters are supported:
Examples:
|
pageSize |
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. |
pageToken |
A page token, received from a previous When paginating, all other parameters provided to |
orderBy |
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
|
readMask |
Mask specifying which fields to read. This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body must be empty.
Response body
Response message for FeaturestoreService.ListEntityTypes
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"entityTypes": [
{
object ( |
Fields | |
---|---|
entityTypes[] |
The EntityTypes matching the request. |
nextPageToken |
A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
aiplatform.entityTypes.list
For more information, see the IAM documentation.