Class: Google::Cloud::DataCatalog::V1::PolicyTag

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#child_policy_tags ⇒ ::Array<::String> (readonly)

Returns Output only. Resource names of child policy tags of this policy tag.

Returns:

  • (::Array<::String>) —

    Output only. Resource names of child policy tags of this policy tag.



153
154
155
156
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 153

class PolicyTag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

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



153
154
155
156
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 153

class PolicyTag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

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



153
154
155
156
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 153

class PolicyTag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of this policy tag in the URL format.

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

Returns:

  • (::String) —

    Output only. Resource name of this policy tag in the URL format.

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



153
154
155
156
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 153

class PolicyTag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent_policy_tag ⇒ ::String

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



153
154
155
156
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 153

class PolicyTag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end