Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#column
def column() -> ::String
-
(::String) —
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
.
to separate the column names. Example:outer_column.inner_column
#column=
def column=(value) -> ::String
-
value (::String) —
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
.
to separate the column names. Example:outer_column.inner_column
-
(::String) —
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
.
to separate the column names. Example:outer_column.inner_column
#fields
def fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}
- (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}) — 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.
#fields=
def fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}
- value (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}) — 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.
- (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}) — 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.
#name
def name() -> ::String
-
(::String) — The resource name of the tag in URL format. Example:
- projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
where
tag_id
is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
#name=
def name=(value) -> ::String
-
value (::String) — The resource name of the tag in URL format. Example:
- projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
where
tag_id
is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
-
(::String) — The resource name of the tag in URL format. Example:
- projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
where
tag_id
is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
#template
def template() -> ::String
-
(::String) — Required. The resource name of the tag template that this tag uses.
Example:
- projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
This field cannot be modified after creation.
#template=
def template=(value) -> ::String
-
value (::String) — Required. The resource name of the tag template that this tag uses.
Example:
- projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
This field cannot be modified after creation.
-
(::String) — Required. The resource name of the tag template that this tag uses.
Example:
- projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
This field cannot be modified after creation.
#template_display_name
def template_display_name() -> ::String
- (::String) — Output only. The display name of the tag template.