Resource: Tag
Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.
See Data Catalog IAM for information on the permissions needed to create or view tags.
JSON representation |
---|
{ "name": string, "template": string, "templateDisplayName": string, "fields": { string: { object ( |
Fields | |
---|---|
name |
Identifier. The resource name of the tag in URL format. Example:
where |
template |
Required. The resource name of the tag template that this tag uses. Example:
This field cannot be modified after creation. |
templateDisplayName |
Output only. The display name of the tag template. |
fields |
Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields. |
Union field scope . The scope within the parent resource that this tag is attached to. If not provided, the tag is attached to the parent resource itself. Deleting the scope from the parent resource will delete all tags attached to that scope. These fields cannot be updated after creation. scope can be only one of the following: |
|
column |
Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use
|
TagField
Contains the value and supporting information for a field within a Tag
.
JSON representation |
---|
{ "displayName": string, "order": integer, // Union field |
Fields | |
---|---|
displayName |
Output only. The display name of this field. |
order |
Output only. The order of this field with respect to other fields in this tag. It can be set in |
Union field kind . Required. The value of this field. kind can be only one of the following: |
|
doubleValue |
Holds the value for a tag field with double type. |
stringValue |
Holds the value for a tag field with string type. |
boolValue |
Holds the value for a tag field with boolean type. |
timestampValue |
Holds the value for a tag field with timestamp type. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
enumValue |
Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. |
EnumValue
Holds an enum value.
JSON representation |
---|
{ "displayName": string } |
Fields | |
---|---|
displayName |
The display name of the enum value. |
Methods |
|
---|---|
|
Creates a tag on an Entry . |
|
Deletes a tag. |
|
Lists tags assigned to an Entry . |
|
Updates an existing tag. |