Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::Taxonomy (v0.17.0)

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>
Returns

#activated_policy_types=

def activated_policy_types=(value) -> ::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::String) — Output only. Resource name of this taxonomy in URL format.

    Note: Policy tag manager generates unique taxonomy IDs.

#policy_tag_count

def policy_tag_count() -> ::Integer
Returns
  • (::Integer) — Output only. Number of policy tags in this taxonomy.

#service

def service() -> ::Google::Cloud::DataCatalog::V1::Taxonomy::Service
Returns

#taxonomy_timestamps

def taxonomy_timestamps() -> ::Google::Cloud::DataCatalog::V1::SystemTimestamps
Returns