Class: Google::Cloud::DataCatalog::V1::Taxonomy

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

Overview

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

Defined Under Namespace

Modules: PolicyType Classes: Service

Instance Attribute Summary collapse

Instance Attribute Details

#activated_policy_types ⇒ ::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>

Returns Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#description ⇒ ::String

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#display_name ⇒ ::String

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#name ⇒ ::String

Returns Identifier. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.

Returns:

  • (::String) —

    Identifier. Resource name of this taxonomy in URL format.

    Note: Policy tag manager generates unique taxonomy IDs.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#policy_tag_count ⇒ ::Integer (readonly)

Returns Output only. Number of policy tags in this taxonomy.

Returns:

  • (::Integer) —

    Output only. Number of policy tags in this taxonomy.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#service ⇒ ::Google::Cloud::DataCatalog::V1::Taxonomy::Service (readonly)

Returns Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#taxonomy_timestamps ⇒ ::Google::Cloud::DataCatalog::V1::SystemTimestamps (readonly)

Returns Output only. Creation and modification timestamps of this taxonomy.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb', line 84

class Taxonomy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1::ManagingSystem]
  #     The Google Cloud service name.
  # @!attribute [rw] identity
  #   @return [::String]
  #     The service agent for the service.
  class Service
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines policy types where the policy tags can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine-grained access control policy that enables access control on
    # tagged sub-resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end