Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1PolicyTag

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb

Overview

Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1PolicyTag

Returns a new instance of GoogleCloudDatacatalogV1beta1PolicyTag.



938
939
940
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 938

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#child_policy_tags ⇒ Array<String>

Output only. Resource names of child policy tags of this policy tag. Corresponds to the JSON property childPolicyTags

Returns:

  • (Array<String>) 


902
903
904
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 902

def child_policy_tags
  @child_policy_tags
end

#description ⇒ String

Description of this policy tag. 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. If not set, defaults to an empty description. Corresponds to the JSON property description

Returns:

  • (String) 


910
911
912
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 910

def description
  @description
end

#display_name ⇒ String

Required. User defined name of this policy tag. It must: be unique within the parent taxonomy; 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. Corresponds to the JSON property displayName

Returns:

  • (String) 


919
920
921
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 919

def display_name
  @display_name
end

#name ⇒ String

Output only. Resource name of this policy tag, whose format is: "projects/project_number/locations/location_id/taxonomies/taxonomy_id/ policyTags/id". Corresponds to the JSON property name

Returns:

  • (String) 


926
927
928
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 926

def name
  @name
end

#parent_policy_tag ⇒ String

Resource name of this policy tag's parent policy tag (e.g. for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag). If empty, it means this policy tag is a top level policy tag (e.g. this field is empty for the "Geolocation" policy tag in the example above). If not set, defaults to an empty string. Corresponds to the JSON property parentPolicyTag

Returns:

  • (String) 


936
937
938
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 936

def parent_policy_tag
  @parent_policy_tag
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



943
944
945
946
947
948
949
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 943

def update!(**args)
  @child_policy_tags = args[:child_policy_tags] if args.key?(:child_policy_tags)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @parent_policy_tag = args[:parent_policy_tag] if args.key?(:parent_policy_tag)
end