Class: Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1Taxonomy

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1/classes.rb,
lib/google/apis/datacatalog_v1/representations.rb,
lib/google/apis/datacatalog_v1/representations.rb

Overview

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: + PII + Account number + Age + SSN + Zipcode + Financials + Revenue A "data origin" taxonomy might contain the following policy tags: + User data + Employee data + Partner data + Public data

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1Taxonomy

Returns a new instance of GoogleCloudDatacatalogV1Taxonomy.



2936
2937
2938
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2936

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


2898
2899
2900
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2898

def activated_policy_types
  @activated_policy_types
end

#description ⇒ String

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

Returns:

  • (String) 


2905
2906
2907
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2905

def description
  @description
end

#display_name ⇒ String

Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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) 


2913
2914
2915
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2913

def display_name
  @display_name
end

#name ⇒ String

Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. Corresponds to the JSON property name

Returns:

  • (String) 


2919
2920
2921
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2919

def name
  @name
end

#policy_tag_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2924
2925
2926
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2924

def policy_tag_count
  @policy_tag_count
end

#service ⇒ Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1TaxonomyService

The source system of the Taxonomy. Corresponds to the JSON property service

Returns:



2929
2930
2931
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2929

def service
  @service
end

#taxonomy_timestamps ⇒ Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SystemTimestamps

Timestamps associated with this resource in a particular system. Corresponds to the JSON property taxonomyTimestamps

Returns:



2934
2935
2936
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2934

def taxonomy_timestamps
  @taxonomy_timestamps
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2941
2942
2943
2944
2945
2946
2947
2948
2949
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2941

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