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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1beta1/classes.rb,
lib/google/apis/datacatalog_v1beta1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Taxonomy

Returns a new instance of GoogleCloudDatacatalogV1beta1Taxonomy.



1574
1575
1576
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1574

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


1540
1541
1542
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1540

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) 


1548
1549
1550
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1548

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. The taxonomy display name must be unique within an organization. Corresponds to the JSON property displayName

Returns:

  • (String) 


1556
1557
1558
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1556

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) 


1562
1563
1564
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1562

def name
  @name
end

#policy_tag_count ⇒ Fixnum

Output only. Number of policy tags contained in this taxonomy. Corresponds to the JSON property policyTagCount

Returns:

  • (Fixnum) 


1567
1568
1569
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1567

def policy_tag_count
  @policy_tag_count
end

#taxonomy_timestamps ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps

Timestamps about this resource according to a particular system. Corresponds to the JSON property taxonomyTimestamps

Returns:



1572
1573
1574
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1572

def taxonomy_timestamps
  @taxonomy_timestamps
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1579

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)
  @policy_tag_count = args[:policy_tag_count] if args.key?(:policy_tag_count)
  @taxonomy_timestamps = args[:taxonomy_timestamps] if args.key?(:taxonomy_timestamps)
end