list method

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

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

Request parameters:

parent - Required. The name of the entry group that contains the entries to list. Can be provided in URL format. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/entryGroups/\[^/\]+$.

pageSize - The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if page_size is more than 1000.

pageToken - Pagination token that specifies the next page to return. If empty, the first page is returned.

readMask - The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the name field, set read_mask to only one path with the name value.

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

Completes with a GoogleCloudDatacatalogV1ListEntriesResponse.

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<GoogleCloudDatacatalogV1ListEntriesResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? readMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    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') + '/entries';

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