TagTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A tag template defines a tag that can have one or more typed fields.
The template is used to create tags that are attached to GCP resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.
Attributes | |
---|---|
Name | Description |
name |
str
The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. |
display_name |
str
Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters. |
is_publicly_readable |
bool
Indicates whether this is a public tag template. Every user has view access to a *public* tag template by default. This means that: - Every user can use this tag template to tag an entry. - If an entry is tagged using the tag template, the tag is always shown in the response to ListTags called on
the entry.
- To get the template using the GetTagTemplate method, you
need view access either on the project or the
organization the tag template resides in but no other
permission is needed.
- Operations on the tag template other than viewing (for
example, editing IAM policies) follow standard IAM
structures.
Tags created with a public tag template are referred to as
public tags.
You can search for a public tag by value with a simple
search query instead of using a tag: predicate.
Public tag templates may not appear in search results
depending on scope, see:
include_public_tag_templates
Note: If an `IAM domain
restriction |
fields |
Sequence[google.cloud.datacatalog_v1.types.TagTemplate.FieldsEntry]
Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: - Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). - Must be at least 1 character and at most 64 characters long. - Must start with a letter or underscore. |
Classes
FieldsEntry
FieldsEntry(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,
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 |