list method

Future<ListMigratingVmsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? view, String? $fields, })

Lists MigratingVms in a given Source.

Request parameters:

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

filter - Optional. The filter request.

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

pageSize - Optional. The maximum number of migrating VMs to return. The service may return fewer than this value. If unspecified, at most 500 migrating VMs 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 ListMigratingVms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigratingVms must match the call that provided the page token.

view - Optional. The level of details of each migrating VM. Possible string values are:

• "MIGRATING_VM_VIEW_UNSPECIFIED" : View is unspecified. The API will fallback to the default value.
• "MIGRATING_VM_VIEW_BASIC" : Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.
• "MIGRATING_VM_VIEW_FULL" : Include everything.

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

Completes with a ListMigratingVmsResponse.

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

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

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