list method

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

Lists all processors which belong to this project.

Request parameters:

parent - Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

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

pageToken - We will return the processors sorted by creation time. The page token will point to the next processor.

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

Completes with a GoogleCloudDocumentaiV1ListProcessorsResponse.

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<GoogleCloudDocumentaiV1ListProcessorsResponse> 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') + '/processors';

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