Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::Taxonomy.
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.
(::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.
#description=
defdescription=(value)->::String
Parameter
value (::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.
Returns
(::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.
#display_name
defdisplay_name()->::String
Returns
(::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.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::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.
Returns
(::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.
#name
defname()->::String
Returns
(::String) — Identifier. Resource name of this taxonomy, whose format is:
"projects/{project_number}/locations/{location_id}/taxonomies/{id}".
#name=
defname=(value)->::String
Parameter
value (::String) — Identifier. Resource name of this taxonomy, whose format is:
"projects/{project_number}/locations/{location_id}/taxonomies/{id}".
Returns
(::String) — Identifier. Resource name of this taxonomy, whose format is:
"projects/{project_number}/locations/{location_id}/taxonomies/{id}".
#policy_tag_count
defpolicy_tag_count()->::Integer
Returns
(::Integer) — Output only. Number of policy tags contained in this taxonomy.
(::Google::Cloud::DataCatalog::V1beta1::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::Taxonomy (v0.9.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.9.1 (latest)](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/latest/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.9.0](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.9.0/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.8.4](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.8.4/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.7.0](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.7.0/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.6.0](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.6.0/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.5.2](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.5.2/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.4.0](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.4.0/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.3.2](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.3.2/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.2.1](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.2.1/Google-Cloud-DataCatalog-V1beta1-Taxonomy)\n- [0.1.1](/ruby/docs/reference/google-cloud-data_catalog-v1beta1/0.1.1/Google-Cloud-DataCatalog-V1beta1-Taxonomy) \nReference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::Taxonomy.\n\nA taxonomy is a collection of policy tags that classify data along a common\naxis. For instance a data *sensitivity* taxonomy could contain policy tags\ndenoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could\ncontain policy tags to distinguish user data, employee data, partner data,\npublic data. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #activated_policy_types\n\n def activated_policy_types() -\u003e ::Array\u003c::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType](./Google-Cloud-DataCatalog-V1beta1-Taxonomy-PolicyType)\\\u003e) --- Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.\n\n### #activated_policy_types=\n\n def activated_policy_types=(value) -\u003e ::Array\u003c::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType](./Google-Cloud-DataCatalog-V1beta1-Taxonomy-PolicyType)\\\u003e) --- Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType](./Google-Cloud-DataCatalog-V1beta1-Taxonomy-PolicyType)\\\u003e) --- Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n The taxonomy display name must be unique within an organization.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\nThe taxonomy display name must be unique within an organization. \n**Returns**\n\n- (::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.\n\n The taxonomy display name must be unique within an organization.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. Resource name of this taxonomy, whose format is: \"projects/{project_number}/locations/{location_id}/taxonomies/{id}\".\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. Resource name of this taxonomy, whose format is: \"projects/{project_number}/locations/{location_id}/taxonomies/{id}\". \n**Returns**\n\n- (::String) --- Identifier. Resource name of this taxonomy, whose format is: \"projects/{project_number}/locations/{location_id}/taxonomies/{id}\".\n\n### #policy_tag_count\n\n def policy_tag_count() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Output only. Number of policy tags contained in this taxonomy.\n\n### #service\n\n def service() -\u003e ::Google::Cloud::DataCatalog::V1beta1::Taxonomy::Service\n\n**Returns**\n\n- ([::Google::Cloud::DataCatalog::V1beta1::Taxonomy::Service](./Google-Cloud-DataCatalog-V1beta1-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.\n\n### #taxonomy_timestamps\n\n def taxonomy_timestamps() -\u003e ::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps\n\n**Returns**\n\n- ([::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps](./Google-Cloud-DataCatalog-V1beta1-SystemTimestamps)) --- Output only. Timestamps about this taxonomy. Only create_time and update_time are used."]]
