REST Resource: tagKeys

Resource: TagKey

A TagKey, used to group a set of TagValues.

JSON representation
{
  "name": string,
  "parent": string,
  "shortName": string,
  "namespacedName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "etag": string
}
Fields
name

string

Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

parent

string

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

shortName

string

Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.

The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

namespacedName

string

Output only. Immutable. Namespaced name of the TagKey.

description

string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

Read-write.

createTime

string (Timestamp format)

Output only. Creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

etag

string

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

Methods

create

Creates a new TagKey.

delete

Deletes a TagKey.

get

Retrieves a TagKey.

getIamPolicy

Gets the access control policy for a TagKey.

list

Lists all TagKeys for a parent resource.

patch

Updates the attributes of the TagKey resource.

setIamPolicy

Sets the access control policy on a TagKey, replacing any existing policy.

testIamPermissions

Returns permissions that a caller has on the specified TagKey.