list method

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

Lists the CutoverJobs of a migrating VM.

Only 25 most recent CutoverJobs are listed.

Request parameters:

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

filter - Optional. The filter request.

orderBy - Optional. the order by fields for the result.

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

pageToken - Required. A page token, received from a previous ListCutoverJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCutoverJobs must match the call that provided the page token.

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

Completes with a ListCutoverJobsResponse.

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<ListCutoverJobsResponse> 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') + '/cutoverJobs';

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