google-cloud-data_catalog-v1 0.4.5 → 0.7.1

data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DataCatalog
+      module V1
+        # A taxonomy is a collection of hierarchical policy tags that classify data
+        # along a common axis. For instance a "data sensitivity" taxonomy could contain
+        # the following policy tags:
+        #
+        # ```
+        # + PII
+        #   + Account number
+        #   + Age
+        #   + SSN
+        #   + Zipcode
+        # + Financials
+        #   + Revenue
+        # ```
+        #
+        # A "data origin" taxonomy could contain the following policy tags:
+        #
+        # ```
+        # + User data
+        # + Employee data
+        # + Partner data
+        # + Public data
+        # ```
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of this taxonomy in format:
+        #     "projects/\\{project_number}/locations/\\{location_id}/taxonomies/\\{taxonomy_id}".
+        #     Note that taxonomy_id's are unique and generated by Policy Tag Manager.
+        # @!attribute [rw] display_name
+        #   @return [::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.
+        # @!attribute [rw] description
+        #   @return [::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.
+        # @!attribute [r] policy_tag_count
+        #   @return [::Integer]
+        #     Output only. Number of policy tags contained in this taxonomy.
+        # @!attribute [r] taxonomy_timestamps
+        #   @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
+        #     Output only. Timestamps about this taxonomy. Only create_time and update_time are used.
+        # @!attribute [rw] activated_policy_types
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>]
+        #     Optional. A list of policy types that are activated for this taxonomy. If not set,
+        #     defaults to an empty list.
+        class Taxonomy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # 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, which enables access control on
+            # tagged sub-resources.
+            FINE_GRAINED_ACCESS_CONTROL = 1
+          end
+        end
+
+        # 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
+        # ```
+        #
+        # Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
+        # "ZipCode".
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of this policy tag in format:
+        #     "projects/\\{project_number}/locations/\\{location_id}/taxonomies/\\{taxonomy_id}/policyTags/\\{policy_tag_id}".
+        #     Both taxonomy_ids and policy_tag_ids are unique and generated by Policy Tag
+        #     Manager.
+        # @!attribute [rw] display_name
+        #   @return [::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.
+        # @!attribute [rw] description
+        #   @return [::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.
+        # @!attribute [rw] parent_policy_tag
+        #   @return [::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.
+        # @!attribute [r] child_policy_tags
+        #   @return [::Array<::String>]
+        #     Output only. Resource names of child policy tags of this policy tag.
+        class PolicyTag
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#create_taxonomy CreateTaxonomy}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the project that the taxonomy will belong to.
+        # @!attribute [rw] taxonomy
+        #   @return [::Google::Cloud::DataCatalog::V1::Taxonomy]
+        #     The taxonomy to be created.
+        class CreateTaxonomyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#delete_taxonomy DeleteTaxonomy}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of the taxonomy to be deleted. All policy tags in
+        #     this taxonomy will also be deleted.
+        class DeleteTaxonomyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#update_taxonomy UpdateTaxonomy}.
+        # @!attribute [rw] taxonomy
+        #   @return [::Google::Cloud::DataCatalog::V1::Taxonomy]
+        #     The taxonomy to update. Only description, display_name, and activated
+        #     policy types can be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource. For the `FieldMask` definition,
+        #     see
+        #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+        #     If not set, defaults to all of the fields that are allowed to update.
+        class UpdateTaxonomyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#list_taxonomies ListTaxonomies}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the project to list the taxonomies of.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of items to return. Must be a value between 1 and 1000.
+        #     If not set, defaults to 50.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The next_page_token value returned from a previous list request, if any. If
+        #     not set, defaults to an empty string.
+        class ListTaxonomiesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#list_taxonomies ListTaxonomies}.
+        # @!attribute [rw] taxonomies
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Taxonomy>]
+        #     Taxonomies that the project contains.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token used to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListTaxonomiesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#get_taxonomy GetTaxonomy}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of the requested taxonomy.
+        class GetTaxonomyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#create_policy_tag CreatePolicyTag}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the taxonomy that the policy tag will belong to.
+        # @!attribute [rw] policy_tag
+        #   @return [::Google::Cloud::DataCatalog::V1::PolicyTag]
+        #     The policy tag to be created.
+        class CreatePolicyTagRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#delete_policy_tag DeletePolicyTag}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of the policy tag to be deleted. All of its descendant
+        #     policy tags will also be deleted.
+        class DeletePolicyTagRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#update_policy_tag UpdatePolicyTag}.
+        # @!attribute [rw] policy_tag
+        #   @return [::Google::Cloud::DataCatalog::V1::PolicyTag]
+        #     The policy tag to update. Only the description, display_name, and
+        #     parent_policy_tag fields can be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource. Only display_name, description and
+        #     parent_policy_tag can be updated and thus can be listed in the mask. If
+        #     update_mask is not provided, all allowed fields (i.e. display_name,
+        #     description and parent) will be updated. For more information including the
+        #     `FieldMask` definition, see
+        #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+        #     If not set, defaults to all of the fields that are allowed to update.
+        class UpdatePolicyTagRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#list_policy_tags ListPolicyTags}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the taxonomy to list the policy tags of.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of items to return. Must be a value between 1 and 1000.
+        #     If not set, defaults to 50.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The next_page_token value returned from a previous List request, if any. If
+        #     not set, defaults to an empty string.
+        class ListPolicyTagsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#list_policy_tags ListPolicyTags}.
+        # @!attribute [rw] policy_tags
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::PolicyTag>]
+        #     The policy tags that are in the requested taxonomy.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token used to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListPolicyTagsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#get_policy_tag GetPolicyTag}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of the requested policy tag.
+        class GetPolicyTagRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DataCatalog
+      module V1
+        # Message representing a taxonomy, including its policy tags in hierarchy, as a
+        # nested proto. Used for taxonomy replacement, import, and export.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the serialized taxonomy. At most 2000 bytes when encoded in
+        #     UTF-8. If not set, defaults to an empty description.
+        # @!attribute [rw] policy_tags
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::SerializedPolicyTag>]
+        #     Top level policy tags associated with the taxonomy, if any.
+        # @!attribute [rw] activated_policy_types
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Taxonomy::PolicyType>]
+        #     A list of policy types that are activated per taxonomy.
+        class SerializedTaxonomy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message representing one policy tag, including all its descendant policy
+        # tags, as a nested proto.
+        # @!attribute [rw] policy_tag
+        #   @return [::String]
+        #     Resource name of the policy tag.
+        #
+        #     This field will be ignored when calling ImportTaxonomies.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the serialized policy tag. The length of the description is
+        #     limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an
+        #     empty description.
+        # @!attribute [rw] child_policy_tags
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::SerializedPolicyTag>]
+        #     Children of the policy tag, if any.
+        class SerializedPolicyTag
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client#import_taxonomies ImportTaxonomies}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of project that the imported taxonomies will belong to.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DataCatalog::V1::InlineSource]
+        #     Inline source used for taxonomies import.
+        # @!attribute [rw] cross_regional_source
+        #   @return [::Google::Cloud::DataCatalog::V1::CrossRegionalSource]
+        #     Cross-regional source taxonomy to be imported.
+        class ImportTaxonomiesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Inline source containing taxonomies to import.
+        # @!attribute [rw] taxonomies
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::SerializedTaxonomy>]
+        #     Required. Taxonomies to be imported.
+        class InlineSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Cross-regional source used to import an existing taxonomy into a different
+        # region.
+        # @!attribute [rw] taxonomy
+        #   @return [::String]
+        #     Required. The resource name of the source taxonomy to be imported.
+        class CrossRegionalSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client#import_taxonomies ImportTaxonomies}.
+        # @!attribute [rw] taxonomies
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Taxonomy>]
+        #     Taxonomies that were imported.
+        class ImportTaxonomiesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client#export_taxonomies ExportTaxonomies}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the project that the exported taxonomies belong to.
+        # @!attribute [rw] taxonomies
+        #   @return [::Array<::String>]
+        #     Required. Resource names of the taxonomies to be exported.
+        # @!attribute [rw] serialized_taxonomies
+        #   @return [::Boolean]
+        #     Export taxonomies as serialized taxonomies, which contain all the policy
+        #     tags as nested protos.
+        class ExportTaxonomiesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client#export_taxonomies ExportTaxonomies}.
+        # @!attribute [rw] taxonomies
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::SerializedTaxonomy>]
+        #     List of taxonomies and policy tags as nested protos.
+        class ExportTaxonomiesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/datacatalog/v1/schema.rb

@@ -24,8 +24,10 @@ module Google
         # Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
         # @!attribute [rw] columns
         #   @return [::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>]
-        #     Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be
-        #     specified.
+        #     The unified GoogleSQL-like schema of columns.
+        #
+        #     The overall maximum number of columns and nested columns is 10,000.
+        #     The maximum nested depth is 15 levels.
         class Schema
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -36,16 +38,26 @@ module Google
         # @!attribute [rw] column
         #   @return [::String]
         #     Required. Name of the column.
+        #
+        #     Must be a UTF-8 string without dots (.).
+        #     The maximum size is 64 bytes.
         # @!attribute [rw] type
         #   @return [::String]
         #     Required. Type of the column.
+        #
+        #     Must be a UTF-8 string with the maximum size of 128 bytes.
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. Description of the column. Default value is an empty string.
+        #
+        #     The description must be a UTF-8 string with the maximum size of 2000
+        #     bytes.
         # @!attribute [rw] mode
         #   @return [::String]
-        #     Optional. A column's mode indicates whether the values in this column are required,
-        #     nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are supported.
+        #     Optional. A column's mode indicates if values in this column are required,
+        #     nullable, or repeated.
+        #
+        #     Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported.
         #     Default mode is `NULLABLE`.
         # @!attribute [rw] subcolumns
         #   @return [::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>]