getNamespaced method

Future<TagKey> getNamespaced({
  1. String? name,
  2. String? $fields,
})

Retrieves a TagKey by its namespaced name.

This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Request parameters:

name - Required. A namespaced tag key name in the format {parentId}/{tagKeyShort}, such as 42/foo for a key with short name "foo" under the organization with ID 42 or r2-d2/bar for a key with short name "bar" under the project r2-d2.

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

Completes with a TagKey.

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

  const url_ = 'v3/tagKeys/namespaced';

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