Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag
- Inherits:
-
Object
- Object
- Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#column ⇒ String
Resources like Entry can have schemas associated with them.
-
#fields ⇒ Hash<String,Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagField>
Required.
-
#name ⇒ String
The resource name of the tag in URL format.
-
#template ⇒ String
Required.
-
#template_display_name ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Tag
constructor
A new instance of GoogleCloudDatacatalogV1beta1Tag.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Tag
Returns a new instance of GoogleCloudDatacatalogV1beta1Tag.
1321 1322 1323 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1321 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
Corresponds to the JSON property column
1292 1293 1294 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1292 def column @column end |
#fields ⇒ Hash<String,Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagField>
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.
Corresponds to the JSON property fields
1299 1300 1301 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1299 def fields @fields end |
#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.
Corresponds to the JSON property name
1307 1308 1309 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1307 def name @name end |
#template ⇒ 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.
Corresponds to the JSON property template
1314 1315 1316 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1314 def template @template end |
#template_display_name ⇒ String
Output only. The display name of the tag template.
Corresponds to the JSON property templateDisplayName
1319 1320 1321 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1319 def template_display_name @template_display_name end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1326 1327 1328 1329 1330 1331 1332 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1326 def update!(**args) @column = args[:column] if args.key?(:column) @fields = args[:fields] if args.key?(:fields) @name = args[:name] if args.key?(:name) @template = args[:template] if args.key?(:template) @template_display_name = args[:template_display_name] if args.key?(:template_display_name) end |