list method

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

Lists the processor types that exist.

Request parameters:

parent - Required. The location of processor types to list. Format: projects/{project}/locations/{location}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

pageSize - The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500. Values above 500 will be coerced to 500.

pageToken - Used to retrieve the next page of results, empty if at the end of the list.

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

Completes with a GoogleCloudDocumentaiV1ListProcessorTypesResponse.

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<GoogleCloudDocumentaiV1ListProcessorTypesResponse> 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_ = 'v1/' + core.Uri.encodeFull('$parent') + '/processorTypes';

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