list method

Future<GoogleLongrunningListOperationsResponse> list(String name, { String? filter, int? pageSize, String? pageToken, bool? returnPartialSuccess, String? $fields, })

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Request parameters:

name - Required. To query for all of the operations for a project. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. A filter for matching the completed or in-progress operations. The supported formats of filter are: To query for only completed operations: done:true To query for only ongoing operations: done:false Must be empty to query for all of the latest operations for the given parent project.

pageSize - The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set or set to less than or equal to 0, the default page size is 100. .

pageToken - Token identifying which result to start with, which is returned by a previous list call.

returnPartialSuccess - When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

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

Completes with a GoogleLongrunningListOperationsResponse.

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<GoogleLongrunningListOperationsResponse> list(
  core.String name, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? returnPartialSuccess,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'returnPartialSuccess': ?returnPartialSuccess == null
        ? null
        : ['${returnPartialSuccess}'],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name') + '/operations';

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