Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::Taxonomy (v0.1.1)

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#activated_policy_types

def activated_policy_types() -> ::Array<::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType>
Returns

#activated_policy_types=

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

#description

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

#description=

def description=(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

def display_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=

def display_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

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".

#policy_tag_count

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

#service

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

#taxonomy_timestamps

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