Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::PolicyTag (v0.23.0)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::PolicyTag.

Denotes one policy tag in a taxonomy, for example, SSN.

Policy tags can be defined in a hierarchy. For example:

```

  • Geolocation
    • LatLong
    • City
    • ZipCode ```

Where the "Geolocation" policy tag contains three children.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#child_policy_tags

def child_policy_tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. Resource names of child policy tags of this policy tag.

#description

def description() -> ::String
Returns
  • (::String) — Description of this policy tag. 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) — Description of this policy tag. 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) — Description of this policy tag. 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 policy tag.

    The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. User-defined name of this policy tag.

    The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.

Returns
  • (::String) — Required. User-defined name of this policy tag.

    The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Resource name of this policy tag in the URL format.

    The policy tag manager generates unique taxonomy IDs and policy tag IDs.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Resource name of this policy tag in the URL format.

    The policy tag manager generates unique taxonomy IDs and policy tag IDs.

Returns
  • (::String) — Identifier. Resource name of this policy tag in the URL format.

    The policy tag manager generates unique taxonomy IDs and policy tag IDs.

#parent_policy_tag

def parent_policy_tag() -> ::String
Returns
  • (::String) — Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

    For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.

#parent_policy_tag=

def parent_policy_tag=(value) -> ::String
Parameter
  • value (::String) — Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

    For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.

Returns
  • (::String) — Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

    For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.