Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::Taxonomy.
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 ```
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#activated_policy_types
def activated_policy_types() -> ::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>- (::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>) — Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
#activated_policy_types=
def activated_policy_types=(value) -> ::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>- value (::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>) — Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
- (::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>) — Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
#description
def description() -> ::String-
(::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.
#description=
def description=(value) -> ::String-
value (::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.
-
(::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.
#display_name
def display_name() -> ::String-
(::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.
#display_name=
def display_name=(value) -> ::String-
value (::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.
-
(::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.
#name
def name() -> ::String-
(::String) — Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
#name=
def name=(value) -> ::String-
value (::String) — Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
-
(::String) — Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
#policy_tag_count
def policy_tag_count() -> ::Integer- (::Integer) — Output only. Number of policy tags in this taxonomy.
#service
def service() -> ::Google::Cloud::DataCatalog::V1::Taxonomy::Service- (::Google::Cloud::DataCatalog::V1::Taxonomy::Service) — Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
#taxonomy_timestamps
def taxonomy_timestamps() -> ::Google::Cloud::DataCatalog::V1::SystemTimestamps- (::Google::Cloud::DataCatalog::V1::SystemTimestamps) — Output only. Creation and modification timestamps of this taxonomy.