list method

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

List inventory data for all VM instances in the specified zone.

Request parameters:

parent - Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$.

filter - If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.

pageSize - The maximum number of results to return.

pageToken - A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.

view - Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC. Possible string values are:

  • "INVENTORY_VIEW_UNSPECIFIED" : The default value. The API defaults to the BASIC view.
  • "BASIC" : Returns the basic inventory information that includes os_info.
  • "FULL" : Returns all fields.

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

Completes with a ListInventoriesResponse.

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

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

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