list method

Future<GoogleCloudAiplatformV1ListEntityTypesResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. String? readMask,
  7. String? $fields,
})

Lists EntityTypes in a given Featurestore.

Request parameters:

parent - Required. The resource name of the Featurestore to list EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/featurestores/\[^/\]+$.

filter - 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.

orderBy - 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

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 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.

readMask - Mask specifying which fields to read.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudAiplatformV1ListEntityTypesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudAiplatformV1ListEntityTypesResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? readMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (readMask != null) 'readMask': [readMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/entityTypes';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudAiplatformV1ListEntityTypesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}