get method

Future<Instance> get(
  1. String name, {
  2. String? fieldMask,
  3. String? $fields,
})

Gets information about a particular instance.

Request parameters:

name - Required. The name of the requested instance. Values are of the form projects//instances/. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+$.

fieldMask - If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

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

Completes with a Instance.

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

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

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