list method
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to
use different resource name schemes, such as users / * /operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users / * }/operations"
to their service configuration. For
backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding is
the parent resource, without the operations collection id.
Request parameters:
filter
- Required. A filter for matching the requested operations. The
supported formats of filter are: To query for a specific function:
project:,location:,function:* To query for all of the latest operations
for a project: project:*,latest:true
name
- Must not be set.
pageSize
- The maximum number of records that should be returned.
Requested page size cannot exceed 100. If not set, the default page size
is 100. Pagination is only supported when querying for a specific
function.
pageToken
- Token identifying which result to start with, which is
returned by a previous list call. Pagination is only supported when
querying for a specific function.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListOperationsResponse.
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<ListOperationsResponse> list({
core.String? filter,
core.String? name,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final _queryParams = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (name != null) 'name': [name],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
const _url = 'v1/operations';
final _response = await _requester.request(
_url,
'GET',
queryParams: _queryParams,
);
return ListOperationsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}