getGuestAttributes method

Future<GuestAttributes> getGuestAttributes(String project, String zone, String instance, { String? queryPath, String? variableKey, String? $fields, })

Returns the specified guest attributes entry.

Request parameters:

project - Project ID for this request. 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\])?)).

zone - The name of the zone for this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

instance - Name of the instance scoping this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

queryPath - Specifies the guest attributes path to be queried.

variableKey - Specifies the key for the guest attributes entry.

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

Completes with a GuestAttributes.

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<GuestAttributes> getGuestAttributes(
  core.String project,
  core.String zone,
  core.String instance, {
  core.String? queryPath,
  core.String? variableKey,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (queryPath != null) 'queryPath': [queryPath],
    if (variableKey != null) 'variableKey': [variableKey],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/zones/' +
      commons.escapeVariable('$zone') +
      '/instances/' +
      commons.escapeVariable('$instance') +
      '/getGuestAttributes';

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