getFromFamily method

Future<Image> getFromFamily(
  1. String project,
  2. String family, {
  3. String? $fields,
})

Returns the latest image that is part of an image family and is not deprecated.

For more information on image families, see Public image families documentation.

Request parameters:

project - The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. Value must have pattern (?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).

family - Name of the image family to search for. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

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

Completes with a Image.

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<Image> getFromFamily(
  core.String project,
  core.String family, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/global/images/family/' +
      commons.escapeVariable('$family');

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