Class: Google::Cloud::DataCatalog::V1beta1::Taxonomy

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

Overview

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.

Defined Under Namespace

Modules: PolicyType Classes: Service

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#description ⇒ ::String

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#display_name ⇒ ::String

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#name ⇒ ::String

Returns Identifier. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".

Returns:

  • (::String) —

    Identifier. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#policy_tag_count ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

#service ⇒ ::Google::Cloud::DataCatalog::V1beta1::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:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end

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

Returns Output only. Timestamps about this taxonomy. Only create_time and update_time are used.

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb', line 62

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

  # The source system of the Taxonomy.
  # @!attribute [rw] name
  #   @return [::Google::Cloud::DataCatalog::V1beta1::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 policy tag can be used for.
  module PolicyType
    # Unspecified policy type.
    POLICY_TYPE_UNSPECIFIED = 0

    # Fine grained access control policy, which enables access control on
    # tagged resources.
    FINE_GRAINED_ACCESS_CONTROL = 1
  end
end