list method

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

Lists the tasks in a queue.

By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.

Request parameters:

parent - Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/queues/\[^/\]+$.

pageSize - Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.

pageToken - A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

responseView - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource. Possible string values are:

  • "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
  • "BASIC" : The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
  • "FULL" : All information is returned. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.

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

Completes with a ListTasksResponse.

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

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

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