Google Cloud Data Catalog V1 Client - Class Taxonomy (1.4.2)

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 message google.cloud.datacatalog.v1.Taxonomy

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. 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.

↳ taxonomy_timestamps Google\Cloud\DataCatalog\V1\SystemTimestamps

Output only. Creation and modification timestamps of this taxonomy.

↳ activated_policy_types array

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

↳ 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.

getName

Output only. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.

Returns
TypeDescription
string

setName

Output only. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPolicyTagCount

Output only. Number of policy tags in this taxonomy.

Returns
TypeDescription
int

setPolicyTagCount

Output only. Number of policy tags in this taxonomy.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTaxonomyTimestamps

Output only. Creation and modification timestamps of this taxonomy.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\SystemTimestamps|null

hasTaxonomyTimestamps

clearTaxonomyTimestamps

setTaxonomyTimestamps

Output only. Creation and modification timestamps of this taxonomy.

Parameter
NameDescription
var Google\Cloud\DataCatalog\V1\SystemTimestamps
Returns
TypeDescription
$this

getActivatedPolicyTypes

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setActivatedPolicyTypes

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getService

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.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\Taxonomy\Service|null

hasService

clearService

setService

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.

Parameter
NameDescription
var Google\Cloud\DataCatalog\V1\Taxonomy\Service
Returns
TypeDescription
$this