list method

Future<ListTransferJobsResponse> list(
  1. String filter, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists transfer jobs.

Request parameters:

filter - Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]} Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED, DISABLED, and DELETED.

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 ListTransferJobsResponse.

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<ListTransferJobsResponse> list(
  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],
  };

  const url_ = 'v1/transferJobs';

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