list method
Lists transfer operations.
Operations are ordered by their creation time in reverse chronological order.
Request parameters:
name
- Required. The name of the type being listed; must be
transferOperations
.
Value must have pattern ^transferOperations$
.
filter
- Required. A list of query parameters specified as JSON text in
the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]}
Since jobNames
,
operationNames
, and transferStatuses
support multiple values, they
must be specified with array notation. projectId
is required.
jobNames
, operationNames
, and transferStatuses
are optional. The
valid values for transferStatuses
are case-insensitive: IN_PROGRESS,
PAUSED, SUCCESS, FAILED, and ABORTED.
pageSize
- The list page size. The max allowed value is 256.
pageToken
- The list page token.
$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 name,
core.String filter, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListOperationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}