list method

Future<ListEntityTypesResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? view,
  5. String? $fields,
})

Lists metadata related to all entity types present in the external system.

Request parameters:

parent - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/connections/\[^/\]+$.

pageSize - Number of entity types to return. Defaults to 25.

pageToken - Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.

view - Specifies which fields of the Entity Type are returned in the response. Possible string values are:

  • "ENTITY_TYPE_VIEW_UNSPECIFIED" : VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.
  • "ENTITY_TYPE_VIEW_BASIC" : Return only entity type names.
  • "ENTITY_TYPE_VIEW_FULL" : Return entity types with schema

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

Completes with a ListEntityTypesResponse.

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<ListEntityTypesResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

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

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