Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Taxonomy

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

A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.

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) ⇒ GoogleCloudDatacatalogV1beta1Taxonomy

Returns a new instance of GoogleCloudDatacatalogV1beta1Taxonomy.



1553
1554
1555
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1553

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#activated_policy_types ⇒ Array<String>

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. Corresponds to the JSON property activatedPolicyTypes

Returns:

  • (Array<String>) 


1529
1530
1531
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1529

def activated_policy_types
  @activated_policy_types
end

#description ⇒ String

Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. Corresponds to the JSON property description

Returns:

  • (String) 


1537
1538
1539
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1537

def description
  @description
end

#display_name ⇒ String

Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. Corresponds to the JSON property displayName

Returns:

  • (String) 


1545
1546
1547
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1545

def display_name
  @display_name
end

#name ⇒ String

Output only. Resource name of this taxonomy, whose format is: "projects/project_number/locations/location_id/taxonomies/id". Corresponds to the JSON property name

Returns:

  • (String) 


1551
1552
1553
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1551

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1558
1559
1560
1561
1562
1563
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1558

def update!(**args)
  @activated_policy_types = args[:activated_policy_types] if args.key?(:activated_policy_types)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
end