Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Tag

Returns a new instance of GoogleCloudDatacatalogV1beta1Tag.



1344
1345
1346
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1344

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

Returns:

  • (String) 


1313
1314
1315
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1313

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

Returns:



1321
1322
1323
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1321

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

Returns:

  • (String) 


1330
1331
1332
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1330

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

Returns:

  • (String) 


1337
1338
1339
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1337

def template
  @template
end

#template_display_name ⇒ String

Output only. The display name of the tag template. Corresponds to the JSON property templateDisplayName

Returns:

  • (String) 


1342
1343
1344
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1342

def template_display_name
  @template_display_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1349
1350
1351
1352
1353
1354
1355
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1349

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