Class TagKey (1.12.2)

Version latest

• 1.12.3 (latest)
• 1.12.2
• 1.11.0
• 1.10.3
• 1.9.1
• 1.8.1
• 1.7.0
• 1.6.3
• 1.5.1
• 1.4.1
• 1.3.3
• 1.2.0
• 1.1.2
• 1.0.2
• 0.30.5
• 0.29.2

TagKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A TagKey, used to group a set of TagValues.

Attributes
Name	Description
name	str 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	str Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}. For a TagKey parented by a Project, its parent can be in the form projects/{project_id} or projects/{project_number}.
short_name	str 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.
namespaced_name	str Output only. Immutable. Namespaced name of the TagKey.
description	str Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Creation time.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Update time.
etag	str Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
purpose	google.cloud.resourcemanager_v3.types.Purpose Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
purpose_data	MutableMapping[str, str] Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose for formatting of this field. Purpose data cannot be changed once set.

Classes

PurposeDataEntry

PurposeDataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.