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 - The name of the operation's parent resource. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+/experiments/\[^/\]+$.

filter - The standard list filter.

pageSize - The standard list page size.

pageToken - The standard list page token.

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_ = 'v1/' + 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>,
  );
}