Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class 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
Generated from protobuf messagegoogle.cloud.datacatalog.v1.Taxonomy
Namespace
Google \ Cloud \ DataCatalog \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
↳ 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.
↳ 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.
↳ policy_tag_count
int
Output only. Number of policy tags in this taxonomy.
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.
getName
Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
Returns
Type
Description
string
setName
Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
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.
Returns
Type
Description
string
setDisplayName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
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.
Returns
Type
Description
string
setDescription
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPolicyTagCount
Output only. Number of policy tags in this taxonomy.
Returns
Type
Description
int
setPolicyTagCount
Output only. Number of policy tags in this taxonomy.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getTaxonomyTimestamps
Output only. Creation and modification timestamps of this taxonomy.
[[["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-04 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class Taxonomy (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.Taxonomy)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.Taxonomy)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.Taxonomy)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.Taxonomy)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.Taxonomy)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.Taxonomy)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.Taxonomy)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.Taxonomy)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.Taxonomy)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.Taxonomy)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.Taxonomy)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.Taxonomy)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.Taxonomy) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class Taxonomy.\n\nA taxonomy is a collection of hierarchical policy tags that classify data\nalong a common axis.\n\nFor example, a \"data sensitivity\" taxonomy might contain the following policy\ntags: \n\n + PII\n + Account number\n + Age\n + SSN\n + Zipcode\n + Financials\n + Revenue\n\nA \"data origin\" taxonomy might contain the following policy tags: \n\n + User data\n + Employee data\n + Partner data\n + Public data\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.Taxonomy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. Resource name of this taxonomy in URL format.\n\nNote: Policy tag manager generates unique taxonomy IDs.\n\n### setName\n\nIdentifier. Resource name of this taxonomy in URL format.\n\nNote: Policy tag manager generates unique taxonomy IDs.\n\n### getDisplayName\n\nRequired. User-defined name of this taxonomy.\n\nThe name can't start or end with spaces, must contain only Unicode letters,\nnumbers, underscores, dashes, and spaces, and be at most 200 bytes long\nwhen encoded in UTF-8.\nThe taxonomy display name must be unique within an organization.\n\n### setDisplayName\n\nRequired. User-defined name of this taxonomy.\n\nThe name can't start or end with spaces, must contain only Unicode letters,\nnumbers, underscores, dashes, and spaces, and be at most 200 bytes long\nwhen encoded in UTF-8.\nThe taxonomy display name must be unique within an organization.\n\n### getDescription\n\nOptional. Description of this taxonomy. If not set, defaults to empty.\n\nThe description must contain only Unicode characters, tabs, newlines,\ncarriage returns, and page breaks, and be at most 2000 bytes long when\nencoded in UTF-8.\n\n### setDescription\n\nOptional. Description of this taxonomy. If not set, defaults to empty.\n\nThe description must contain only Unicode characters, tabs, newlines,\ncarriage returns, and page breaks, and be at most 2000 bytes long when\nencoded in UTF-8.\n\n### getPolicyTagCount\n\nOutput only. Number of policy tags in this taxonomy.\n\n### setPolicyTagCount\n\nOutput only. Number of policy tags in this taxonomy.\n\n### getTaxonomyTimestamps\n\nOutput only. Creation and modification timestamps of this taxonomy.\n\n### hasTaxonomyTimestamps\n\n### clearTaxonomyTimestamps\n\n### setTaxonomyTimestamps\n\nOutput only. Creation and modification timestamps of this taxonomy.\n\n### getActivatedPolicyTypes\n\nOptional. A list of policy types that are activated for this taxonomy. If\nnot set, defaults to an empty list.\n\n### setActivatedPolicyTypes\n\nOptional. A list of policy types that are activated for this taxonomy. If\nnot set, defaults to an empty list.\n\n### getService\n\nOutput only. Identity of the service which owns the Taxonomy. This field is\nonly populated when the taxonomy is created by a Google Cloud service.\n\nCurrently only 'DATAPLEX' is supported.\n\n### hasService\n\n### clearService\n\n### setService\n\nOutput only. Identity of the service which owns the Taxonomy. This field is\nonly populated when the taxonomy is created by a Google Cloud service.\n\nCurrently only 'DATAPLEX' is supported."]]
