# Google Cloud Data Catalog V1 Client - Class Taxonomy (2.4.2)

2.4.2 (latest) 2.4.1 2.3.2 2.2.4 2.1.0 2.0.2 1.10.3 1.9.1 1.8.2 1.7.1 1.6.0 1.5.1 1.4.2 1.3.9 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`

## 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. |
| `↳ taxonomy_timestamps` | `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/V1.SystemTimestamps` Output only. Creation and modification timestamps of this taxonomy. |
| `↳ activated_policy_types` | `int[]` Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. |
| `↳ service` | `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/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

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/V1.SystemTimestamps|null` |   |

### hasTaxonomyTimestamps

### clearTaxonomyTimestamps

### setTaxonomyTimestamps

Output only. Creation and modification timestamps of this taxonomy.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/V1.SystemTimestamps` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getActivatedPolicyTypes

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<int>` |   |

### setActivatedPolicyTypes

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/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** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-data-catalog/latest/V1.Taxonomy.Service` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |