list method

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

List the entries for the glossary.

Request parameters:

parent - Required. The parent glossary resource name for listing the glossary's entries. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/glossaries/\[^/\]+$.

pageSize - Optional. Requested page size. The server may return fewer glossary entries than requested. If unspecified, the server picks an appropriate default.

pageToken - Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossaryEntriesResponse.next_page_token] returned from the previous call. The first page is returned if page_tokenis empty or missing.

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

Completes with a ListGlossaryEntriesResponse.

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

  final url_ = 'v3/' + core.Uri.encodeFull('$parent') + '/glossaryEntries';

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