list method

Future<ListDiskMigrationJobsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. String? $fields,
})

Lists DiskMigrationJobs in a given Source.

Request parameters:

parent - Required. The parent, which owns this collection of DiskMigrationJobs. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/sources/\[^/\]+$.

filter - Optional. The filter request (according to AIP-160).

orderBy - Optional. Ordering of the result list.

pageSize - Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - Optional. A page token, received from a previous ListDiskMigrationJobs call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to ListDiskMigrationJobs except page_size must match the call that provided the page token.

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

Completes with a ListDiskMigrationJobsResponse.

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<ListDiskMigrationJobsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/diskMigrationJobs';

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