google-cloud-data_catalog-v1 0.9.1 → 0.12.0

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

@@ -69,6 +69,7 @@ module Google
         #
         #     * `relevance` that can only be descending
         #     * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
+        #     * `default` that can only be descending
         #
         #     If this parameter is omitted, it defaults to the descending `relevance`.
         class SearchCatalogRequest
@@ -108,17 +109,15 @@ module Google
           #     `SearchCatalogResponse.unreachable` field. To get additional information
           #     on the error, repeat the search request and set the location name as the
           #     value of this parameter.
-          # @!attribute [rw] include_public_tag_templates
+          # @!attribute [rw] starred_only
           #   @return [::Boolean]
-          #     Optional. If `true`, include [public tag
-          #     templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
-          #     in the search results. By default, they are included only if you have
-          #     explicit permissions on them to view them. For example, if you are the
-          #     owner.
+          #     Optional. If `true`, search only among starred entries.
           #
-          #     Other scope fields, for example, `include_org_ids`,
-          #     still restrict the returned public tag templates and at least one of
-          #     them is required.
+          #     By default, all results are returned, starred or not.
+          # @!attribute [rw] include_public_tag_templates
+          #   @return [::Boolean]
+          #     Optional. This field is deprecated. The search mechanism for public and private tag
+          #     templates is the same.
           class Scope
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -503,6 +502,10 @@ module Google
         #   @return [::Google::Cloud::DataCatalog::V1::RoutineSpec]
         #     Specification that applies to a user-defined function or procedure. Valid
         #     only for entries with the `ROUTINE` type.
+        # @!attribute [rw] fileset_spec
+        #   @return [::Google::Cloud::DataCatalog::V1::FilesetSpec]
+        #     Specification that applies to a fileset resource. Valid only
+        #     for entries with the `FILESET` type.
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Display name of an entry.
@@ -521,6 +524,9 @@ module Google
         #     (CR), and page breaks (FF).
         #     The maximum size is 2000 bytes when encoded in UTF-8.
         #     Default value is an empty string.
+        # @!attribute [rw] business_context
+        #   @return [::Google::Cloud::DataCatalog::V1::BusinessContext]
+        #     Business Context of the entry. Not supported for BigQuery datasets
         # @!attribute [rw] schema
         #   @return [::Google::Cloud::DataCatalog::V1::Schema]
         #     Schema of the entry. An entry might not have any schema attached to it.
@@ -545,6 +551,9 @@ module Google
         # @!attribute [r] data_source
         #   @return [::Google::Cloud::DataCatalog::V1::DataSource]
         #     Output only. Physical location of the entry.
+        # @!attribute [r] personal_details
+        #   @return [::Google::Cloud::DataCatalog::V1::PersonalDetails]
+        #     Output only. Additional information related to the entry. Private to the current user.
         class Entry
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -564,6 +573,10 @@ module Google
         # @!attribute [rw] type
         #   @return [::Google::Cloud::DataCatalog::V1::DatabaseTableSpec::TableType]
         #     Type of this table.
+        # @!attribute [rw] dataplex_table
+        #   @return [::Google::Cloud::DataCatalog::V1::DataplexTableSpec]
+        #     Fields specific to a Dataplex table and present only in the Dataplex table
+        #     entries.
         class DatabaseTableSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -581,6 +594,17 @@ module Google
           end
         end
 
+        # Specification that applies to a fileset. Valid only for entries with the
+        # 'FILESET' type.
+        # @!attribute [rw] dataplex_fileset
+        #   @return [::Google::Cloud::DataCatalog::V1::DataplexFilesetSpec]
+        #     Fields specific to a Dataplex fileset and present only in the Dataplex
+        #     fileset entries.
+        class FilesetSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Specification that applies to a data source connection. Valid only for
         # entries with the `DATA_SOURCE_CONNECTION` type.
         # @!attribute [rw] bigquery_connection_spec
@@ -665,6 +689,55 @@ module Google
           end
         end
 
+        # Business Context of the entry.
+        # @!attribute [rw] entry_overview
+        #   @return [::Google::Cloud::DataCatalog::V1::EntryOverview]
+        #     Entry overview fields for rich text descriptions of entries.
+        # @!attribute [rw] contacts
+        #   @return [::Google::Cloud::DataCatalog::V1::Contacts]
+        #     Contact people for the entry.
+        class BusinessContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Entry overview fields for rich text descriptions of entries.
+        # @!attribute [rw] overview
+        #   @return [::String]
+        #     Entry overview with support for rich text.
+        #
+        #     The overview must only contain Unicode characters, and should be
+        #     formatted using HTML.
+        #     The maximum length is 10 MiB as this value holds HTML descriptions
+        #     including encoded images. The maximum length of the text without images
+        #     is 100 KiB.
+        class EntryOverview
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contact people for the entry.
+        # @!attribute [rw] people
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::Contacts::Person>]
+        #     The list of contact people for the entry.
+        class Contacts
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A contact person for the entry.
+          # @!attribute [rw] designation
+          #   @return [::String]
+          #     Designation of the person, for example, Data Steward.
+          # @!attribute [rw] email
+          #   @return [::String]
+          #     Email of the person in the format of `john.doe@xyz`,
+          #     `<john.doe@xyz>`, or `John Doe<john.doe@xyz>`.
+          class Person
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Entry group metadata.
         #
         # An `EntryGroup` resource represents a logical grouping of zero or more
@@ -738,9 +811,7 @@ module Google
         #     request body, their values are emptied.
         #
         #     Note: Updating the `is_publicly_readable` field may require up to 12
-        #     hours to take effect in search results. Additionally, it also requires
-        #     the `tagTemplates.getIamPolicy` and `tagTemplates.setIamPolicy`
-        #     permissions.
+        #     hours to take effect in search results.
         class UpdateTagTemplateRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -980,6 +1051,68 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#star_entry StarEntry}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entry to mark as starred.
+        class StarEntryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#star_entry StarEntry}.
+        # Empty for now
+        class StarEntryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#unstar_entry UnstarEntry}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entry to mark as **not** starred.
+        class UnstarEntryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#unstar_entry UnstarEntry}.
+        # Empty for now
+        class UnstarEntryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#modify_entry_overview ModifyEntryOverview}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the entry.
+        # @!attribute [rw] entry_overview
+        #   @return [::Google::Cloud::DataCatalog::V1::EntryOverview]
+        #     Required. The new value for the Entry Overview.
+        class ModifyEntryOverviewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#modify_entry_contacts ModifyEntryContacts}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the entry.
+        # @!attribute [rw] contacts
+        #   @return [::Google::Cloud::DataCatalog::V1::Contacts]
+        #     Required. The new value for the Contacts.
+        class ModifyEntryContactsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The enum field that lists all the types of entry resources in Data
         # Catalog. For example, a BigQuery table entry has the `TABLE` type.
         module EntryType
@@ -1016,6 +1149,12 @@ module Google
           # Output only. Routine, for example, a BigQuery routine.
           ROUTINE = 9
 
+          # A Dataplex lake.
+          LAKE = 10
+
+          # A Dataplex zone.
+          ZONE = 11
+
           # A service, for example, a Dataproc Metastore service.
           SERVICE = 14
         end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+        # Common Dataplex fields.
+        # @!attribute [rw] asset
+        #   @return [::String]
+        #     Fully qualified resource name of an asset in Dataplex, to which the
+        #     underlying data source (Cloud Storage bucket or BigQuery dataset) of the
+        #     entity is attached.
+        # @!attribute [rw] data_format
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema]
+        #     Format of the data.
+        # @!attribute [rw] compression_format
+        #   @return [::String]
+        #     Compression format of the data, e.g., zip, gzip etc.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Project ID of the underlying Cloud Storage or BigQuery data. Note that
+        #     this may not be the same project as the correspondingly Dataplex lake /
+        #     zone / asset.
+        class DataplexSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Entry specyfication for a Dataplex fileset.
+        # @!attribute [rw] dataplex_spec
+        #   @return [::Google::Cloud::DataCatalog::V1::DataplexSpec]
+        #     Common Dataplex fields.
+        class DataplexFilesetSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Entry specification for a Dataplex table.
+        # @!attribute [rw] external_tables
+        #   @return [::Array<::Google::Cloud::DataCatalog::V1::DataplexExternalTable>]
+        #     List of external tables registered by Dataplex in other systems based on
+        #     the same underlying data.
+        #
+        #     External tables allow to query this data in those systems.
+        # @!attribute [rw] dataplex_spec
+        #   @return [::Google::Cloud::DataCatalog::V1::DataplexSpec]
+        #     Common Dataplex fields.
+        # @!attribute [rw] user_managed
+        #   @return [::Boolean]
+        #     Indicates if the table schema is managed by the user or not.
+        class DataplexTableSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # External table registered by Dataplex.
+        # Dataplex publishes data discovered from an asset into multiple other systems
+        # (BigQuery, DPMS) in form of tables. We call them "external tables". External
+        # tables are also synced into the Data Catalog.
+        # This message contains pointers to
+        # those external tables (fully qualified name, resource name et cetera) within
+        # the Data Catalog.
+        # @!attribute [rw] system
+        #   @return [::Google::Cloud::DataCatalog::V1::IntegratedSystem]
+        #     Service in which the external table is registered.
+        # @!attribute [rw] fully_qualified_name
+        #   @return [::String]
+        #     Fully qualified name (FQN) of the external table.
+        # @!attribute [rw] google_cloud_resource
+        #   @return [::String]
+        #     Google Cloud resource name of the external table.
+        # @!attribute [rw] data_catalog_entry
+        #   @return [::String]
+        #     Name of the Data Catalog entry representing the external table.
+        class DataplexExternalTable
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+        # Native schema used by a resource represented as an entry. Used by query
+        # engines for deserializing and parsing source data.
+        # @!attribute [rw] avro
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::AvroSchema]
+        #     Schema in Avro JSON format.
+        # @!attribute [rw] thrift
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::ThriftSchema]
+        #     Schema in Thrift format.
+        # @!attribute [rw] protobuf
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::ProtobufSchema]
+        #     Schema in protocol buffer format.
+        # @!attribute [rw] parquet
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::ParquetSchema]
+        #     Marks a Parquet-encoded data source.
+        # @!attribute [rw] orc
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::OrcSchema]
+        #     Marks an ORC-encoded data source.
+        # @!attribute [rw] csv
+        #   @return [::Google::Cloud::DataCatalog::V1::PhysicalSchema::CsvSchema]
+        #     Marks a CSV-encoded data source.
+        class PhysicalSchema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Schema in Avro JSON format.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     JSON source of the Avro schema.
+          class AvroSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Schema in Thrift format.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     Thrift IDL source of the schema.
+          class ThriftSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Schema in protocol buffer format.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     Protocol buffer source of the schema.
+          class ProtobufSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Marks a Parquet-encoded data source.
+          class ParquetSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Marks an ORC-encoded data source.
+          class OrcSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Marks a CSV-encoded data source.
+          class CsvSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -57,6 +57,8 @@ module Google
         #     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.
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. Description of this taxonomy. If not set, defaults to empty.

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

@@ -149,33 +149,12 @@ module Google
         #     The maximum length is 200 characters.
         # @!attribute [rw] is_publicly_readable
         #   @return [::Boolean]
-        #     Indicates whether this is a public tag template.
+        #     Indicates whether tags created with this template are public. Public tags
+        #     do not require tag template access to appear in
+        #     [ListTags][google.cloud.datacatalog.v1.ListTags] API response.
         #
-        #     Every user has view access to a *public* tag template by default.
-        #     This means that:
-        #
-        #       * Every user can use this tag template to tag an entry.
-        #       * If an entry is tagged using the tag template, the tag is always
-        #         shown in the response to ``ListTags`` called on the entry.
-        #       * To get the template using the GetTagTemplate method, you
-        #         need view access either on the project or the organization the tag
-        #         template resides in but no other permission is needed.
-        #       * Operations on the tag template other than viewing (for example,
-        #         editing IAM policies) follow standard IAM structures.
-        #
-        #     Tags created with a public tag template are referred to as public tags.
-        #
-        #     You can search for a public tag by value with a
-        #     simple search query instead of using a ``tag:`` predicate.
-        #
-        #     Public tag templates may not appear in search results depending on scope,
-        #     see:
-        #     {::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope#include_public_tag_templates include_public_tag_templates}
-        #
-        #     Note: If an [IAM domain
-        #     restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
-        #     is configured in the tag template's location, the public access will not be
-        #     enabled but the simple search for tag values will still work.
+        #     Additionally, you can search for a public tag by value with a
+        #     simple search query in addition to using a ``tag:`` predicate.
         # @!attribute [rw] fields
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}]
         #     Required. Map of tag template field IDs to the settings for the field.

data/proto_docs/google/iam/v1/iam_policy.rb

@@ -31,6 +31,13 @@ module Google
       #     the policy is limited to a few 10s of KB. An empty policy is a
       #     valid policy but certain Cloud Platform services (such as Projects)
       #     might reject them.
+      # @!attribute [rw] update_mask
+      #   @return [::Google::Protobuf::FieldMask]
+      #     OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+      #     the fields in the mask will be modified. If no mask is provided, the
+      #     following default mask is used:
+      #
+      #     `paths: "bindings, etag"`
       class SetIamPolicyRequest
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -44,7 +51,7 @@ module Google
       # @!attribute [rw] options
       #   @return [::Google::Iam::V1::GetPolicyOptions]
       #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
-      #     `GetIamPolicy`. This field is only used by Cloud IAM.
+      #     `GetIamPolicy`.
       class GetIamPolicyRequest
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/iam/v1/options.rb

@@ -23,14 +23,24 @@ module Google
       # Encapsulates settings provided to GetIamPolicy.
       # @!attribute [rw] requested_policy_version
       #   @return [::Integer]
-      #     Optional. The policy format version to be returned.
+      #     Optional. The maximum policy version that will be used to format the
+      #     policy.
       #
       #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
       #     rejected.
       #
-      #     Requests for policies with any conditional bindings must specify version 3.
-      #     Policies without any conditional bindings may specify any valid value or
-      #     leave the field unset.
+      #     Requests for policies with any conditional role bindings must specify
+      #     version 3. Policies with no conditional role bindings may specify any valid
+      #     value or leave the field unset.
+      #
+      #     The policy in the response might use the policy version that you specified,
+      #     or it might use a lower policy version. For example, if you specify version
+      #     3, but the policy has no conditional role bindings, the response uses
+      #     version 1.
+      #
+      #     To learn which resources support conditions in their IAM policies, see the
+      #     [IAM
+      #     documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
       class GetPolicyOptions
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods