google-cloud-data_catalog-v1 0.7.3 → 0.8.3

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

@@ -27,12 +27,12 @@ module Google
         #     Output only. The table source type.
         # @!attribute [rw] view_spec
         #   @return [::Google::Cloud::DataCatalog::V1::ViewSpec]
-        #     Table view specification. This field should only be populated if
-        #     `table_source_type` is `BIGQUERY_VIEW`.
+        #     Table view specification. Populated only if
+        #     the `table_source_type` is `BIGQUERY_VIEW`.
         # @!attribute [rw] table_spec
         #   @return [::Google::Cloud::DataCatalog::V1::TableSpec]
-        #     Spec of a BigQuery table. This field should only be populated if
-        #     `table_source_type` is `BIGQUERY_TABLE`.
+        #     Specification of a BigQuery table. Populated only if
+        #     the `table_source_type` is `BIGQUERY_TABLE`.
         class BigQueryTableSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -47,31 +47,38 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Normal BigQuery table spec.
+        # Normal BigQuery table specification.
         # @!attribute [r] grouped_entry
         #   @return [::String]
-        #     Output only. If the table is a dated shard, i.e., with name pattern `[prefix]YYYYMMDD`,
-        #     `grouped_entry` is the Data Catalog resource name of the date sharded
-        #     grouped entry, for example,
-        #     `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
+        #     Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD`
+        #     name pattern, this field is the Data Catalog resource name of the
+        #     date-sharded grouped entry. For example:
+        #
+        #     `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`.
+        #
         #     Otherwise, `grouped_entry` is empty.
         class TableSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`.
-        # Context:
-        # https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
+        # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name
+        # pattern.
+        #
+        # For more information, see [Introduction to partitioned tables]
+        # (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
         # @!attribute [r] dataset
         #   @return [::String]
         #     Output only. The Data Catalog resource name of the dataset entry the current table
-        #     belongs to, for example,
-        #     `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
+        #     belongs to. For example:
+        #
+        #     `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`.
         # @!attribute [r] table_prefix
         #   @return [::String]
-        #     Output only. The table name prefix of the shards. The name of any given shard is
-        #     `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the
+        #     Output only. The table name prefix of the shards.
+        #
+        #     The name of any given shard is `[table_prefix]YYYYMMDD`.
+        #     For example, for the `MyTable20180101` shard, the
         #     `table_prefix` is `MyTable`.
         # @!attribute [r] shard_count
         #   @return [::Integer]

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

@@ -21,27 +21,24 @@ module Google
   module Cloud
     module DataCatalog
       module V1
-        # Tags are used to attach custom metadata to Data Catalog resources. Tags
-        # conform to the specifications within their tag template.
+        # Tags contain custom metadata and are attached to Data Catalog resources. Tags
+        # conform with the specification of their tag template.
         #
         # See [Data Catalog
         # IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
         # on the permissions needed to create or view tags.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The resource name of the tag in URL format. Example:
-        #
-        #     `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}`
-        #
-        #     where `tag_id` is a system-generated identifier.
+        #     The resource name of the tag in URL format where tag ID is a
+        #     system-generated identifier.
         #
         #     Note: The tag itself might not be stored in the location specified in its
         #     name.
         # @!attribute [rw] template
         #   @return [::String]
-        #     Required. The resource name of the tag template that this tag uses. Example:
+        #     Required. The resource name of the tag template this tag uses. Example:
         #
-        #     `projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}`
+        #     `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}`
         #
         #     This field cannot be modified after creation.
         # @!attribute [r] template_display_name
@@ -50,14 +47,16 @@ module Google
         # @!attribute [rw] column
         #   @return [::String]
         #     Resources like entry can have schemas associated with them. This scope
-        #     allows users to attach tags to an individual column based on that schema.
+        #     allows you to attach tags to an individual column based on that schema.
         #
         #     To attach a tag to a nested column, separate column names with a dot
         #     (`.`). Example: `column.nested_column`.
         # @!attribute [rw] fields
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}]
-        #     Required. This maps the ID of a tag field to the value of and additional information
-        #     about that field. Valid field IDs are defined by the tag's template. A tag
+        #     Required. Maps the ID of a tag field to its value and additional information
+        #     about that field.
+        #
+        #     Tag template defines valid field IDs. A tag
         #     must have at least 1 field and at most 500 fields.
         class Tag
           include ::Google::Protobuf::MessageExts
@@ -73,40 +72,50 @@ module Google
           end
         end
 
-        # Contains the value and supporting information for a field within
+        # Contains the value and additional information on a field within
         # a {::Google::Cloud::DataCatalog::V1::Tag Tag}.
         # @!attribute [r] display_name
         #   @return [::String]
         #     Output only. The display name of this field.
         # @!attribute [rw] double_value
         #   @return [::Float]
-        #     Holds the value for a tag field with double type.
+        #     The value of a tag field with a double type.
         # @!attribute [rw] string_value
         #   @return [::String]
-        #     Holds the value for a tag field with string type.
+        #     The value of a tag field with a string type.
+        #
         #     The maximum length is 2000 UTF-8 characters.
         # @!attribute [rw] bool_value
         #   @return [::Boolean]
-        #     Holds the value for a tag field with boolean type.
+        #     The value of a tag field with a boolean type.
         # @!attribute [rw] timestamp_value
         #   @return [::Google::Protobuf::Timestamp]
-        #     Holds the value for a tag field with timestamp type.
+        #     The value of a tag field with a timestamp type.
         # @!attribute [rw] enum_value
         #   @return [::Google::Cloud::DataCatalog::V1::TagField::EnumValue]
-        #     Holds the value for a tag field with enum type. This value must be
-        #     one of the allowed values in the definition of this enum.
+        #     The value of a tag field with an enum type.
+        #
+        #     This value must be one of the allowed values listed in this enum.
+        # @!attribute [rw] richtext_value
+        #   @return [::String]
+        #     The value of a tag field with a rich text type.
+        #
+        #     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.
         # @!attribute [r] order
         #   @return [::Integer]
-        #     Output only. The order of this field with respect to other fields in this tag. It can be
-        #     set in {::Google::Cloud::DataCatalog::V1::TagTemplateField#order Tag}. For
-        #     example, a higher value can indicate a more important field. The value can
-        #     be negative. Multiple fields can have the same order, and field orders
-        #     within a tag do not have to be sequential.
+        #     Output only. The order of this field with respect to other fields in this tag. Can be
+        #     set by {::Google::Cloud::DataCatalog::V1::TagTemplateField#order Tag}.
+        #
+        #     For example, a higher value can indicate a more important field.
+        #     The value can be negative. Multiple fields can have the same order, and
+        #     field orders within a tag don't have to be sequential.
         class TagField
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Holds an enum value.
+          # An enum value.
           # @!attribute [rw] display_name
           #   @return [::String]
           #     The display name of the enum value.
@@ -116,19 +125,18 @@ module Google
           end
         end
 
-        # A tag template defines a tag, which can have one or more typed fields.
-        # The template is used to create and attach the tag to GCP resources.
-        # [Tag template
-        # roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
-        # provide permissions to create, edit, and use the template. See, for example,
-        # the [TagTemplate
-        # User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
-        # which includes permission to use the tag template to tag resources.
+        # A tag template defines a tag that can have one or more typed fields.
+        #
+        # The template is used to create tags that are attached to GCP resources.
+        # [Tag template roles]
+        # (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
+        # provide permissions to create, edit, and use the template. For example,
+        # see the [TagTemplate User]
+        # (https://cloud.google.com/data-catalog/docs/how-to/template-user) role
+        # that includes a permission to use the tag template to tag resources.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The resource name of the tag template in URL format. Example:
-        #
-        #     `projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}`
+        #     The resource name of the tag template in URL format.
         #
         #     Note: The tag template itself and its child resources might not be
         #     stored in the location specified in its name.
@@ -139,16 +147,48 @@ module Google
         #     The name must contain only Unicode letters, numbers (0-9), underscores (_),
         #     dashes (-), spaces ( ), and can't start or end with spaces.
         #     The maximum length is 200 characters.
+        # @!attribute [rw] is_publicly_readable
+        #   @return [::Boolean]
+        #     Indicates whether this is a public tag template.
+        #
+        #     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.
         # @!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.
-        #     This map is an exhaustive list of the allowed fields. This map must contain
+        #     This map is an exhaustive list of the allowed fields. The map must contain
         #     at least one field and at most 500 fields.
         #
-        #     The keys to this map are tag template field IDs. Field IDs can contain
-        #     letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
-        #     Field IDs must be at least 1 character long and at most
-        #     64 characters long. Field IDs must start with a letter or underscore.
+        #     The keys to this map are tag template field IDs. The IDs have the
+        #     following limitations:
+        #
+        #     * Can contain uppercase and lowercase letters, numbers (0-9) and
+        #       underscores (_).
+        #     * Must be at least 1 character and at most 64 characters long.
+        #     * Must start with a letter or underscore.
         class TagTemplate
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,9 +208,9 @@ module Google
         #   @return [::String]
         #     Output only. The resource name of the tag template field in URL format. Example:
         #
-        #     `projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}`
+        #     `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
         #
-        #     Note: The `TagTemplateField` itself might not be stored in the location
+        #     Note: The tag template field itself might not be stored in the location
         #     specified in its name.
         #
         #     The name must contain only letters (a-z, A-Z), numbers (0-9),
@@ -188,16 +228,18 @@ module Google
         #     Required. The type of value this tag field can contain.
         # @!attribute [rw] is_required
         #   @return [::Boolean]
-        #     Whether this is a required field. Defaults to false.
+        #     If true, this field is required. Defaults to false.
         # @!attribute [rw] description
         #   @return [::String]
         #     The description for this field. Defaults to an empty string.
         # @!attribute [rw] order
         #   @return [::Integer]
         #     The order of this field with respect to other fields in this tag
-        #     template. For example, a higher value can indicate a more important field.
-        #     The value can be negative. Multiple fields can have the same order, and
-        #     field orders within a tag do not have to be sequential.
+        #     template.
+        #
+        #     For example, a higher value can indicate a more important field.
+        #     The value can be negative. Multiple fields can have the same order and
+        #     field orders within a tag don't have to be sequential.
         class TagTemplateField
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -205,10 +247,10 @@ module Google
 
         # @!attribute [rw] primitive_type
         #   @return [::Google::Cloud::DataCatalog::V1::FieldType::PrimitiveType]
-        #     Represents primitive types - string, bool etc.
+        #     Primitive types, such as string, boolean, etc.
         # @!attribute [rw] enum_type
         #   @return [::Google::Cloud::DataCatalog::V1::FieldType::EnumType]
-        #     Represents an enum type.
+        #     An enum type.
         class FieldType
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -222,7 +264,7 @@ module Google
           #     be case-insensitively unique within this set.
           #
           #     The order of items in this set is preserved. This field can be used to
-          #     create, remove and reorder enum values. To rename enum values, use the
+          #     create, remove, and reorder enum values. To rename enum values, use the
           #     `RenameTagTemplateFieldEnumValue` method.
           class EnumType
             include ::Google::Protobuf::MessageExts
@@ -242,7 +284,7 @@ module Google
           end
 
           module PrimitiveType
-            # This is the default invalid value for a type.
+            # The default invalid value for a type.
             PRIMITIVE_TYPE_UNSPECIFIED = 0
 
             # A double precision number.
@@ -256,6 +298,9 @@ module Google
 
             # A timestamp.
             TIMESTAMP = 4
+
+            # A Richtext description.
+            RICHTEXT = 5
           end
         end
       end

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

@@ -21,17 +21,24 @@ module Google
   module Cloud
     module DataCatalog
       module V1
-        # Timestamps about this resource according to a particular system.
+        # Timestamps associated with this resource in a particular system.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     The creation time of the resource within the given system.
+        #     Creation timestamp of the resource within the given system.
         # @!attribute [rw] update_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     The last-modified time of the resource within the given system.
+        #     Timestamp of the last modification of the resource or its metadata within
+        #     a given system.
+        #
+        #     Note: Depending on the source system, not every modification updates this
+        #     timestamp.
+        #     For example, BigQuery timestamps every metadata modification but not data
+        #     or permission changes.
         # @!attribute [r] expire_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The expiration time of the resource within the given system.
-        #     Currently only apllicable to BigQuery resources.
+        #     Output only. Expiration timestamp of the resource within the given system.
+        #
+        #     Currently only applicable to BigQuery resources.
         class SystemTimestamps
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,79 @@
+# 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
+        # Detailed statistics on the entry's usage.
+        #
+        # Usage statistics have the following limitations:
+        #
+        # - Only BigQuery tables have them.
+        # - They only include BigQuery query jobs.
+        # - They might be underestimated because wildcard table references
+        #   are not yet counted. For more information, see
+        #   [Querying multiple tables using a wildcard table]
+        #   (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)
+        # @!attribute [rw] total_completions
+        #   @return [::Float]
+        #     The number of successful uses of the underlying entry.
+        # @!attribute [rw] total_failures
+        #   @return [::Float]
+        #     The number of failed attempts to use the underlying entry.
+        # @!attribute [rw] total_cancellations
+        #   @return [::Float]
+        #     The number of cancelled attempts to use the underlying entry.
+        # @!attribute [rw] total_execution_time_for_completions_millis
+        #   @return [::Float]
+        #     Total time spent only on successful uses, in milliseconds.
+        class UsageStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The set of all usage signals that Data Catalog stores.
+        #
+        # Note: Usually, these signals are updated daily. In rare cases, an update may
+        # fail but will be performed again on the next day.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The end timestamp of the duration of usage statistics.
+        # @!attribute [rw] usage_within_time_range
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::UsageStats}]
+        #     Usage statistics over each of the predefined time ranges.
+        #
+        #     Supported time ranges are `{"24H", "7D", "30D"}`.
+        class UsageSignal
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DataCatalog::V1::UsageStats]
+          class UsageWithinTimeRangeEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-data_catalog-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -206,6 +206,7 @@ files:
 - lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/credentials.rb
 - lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/paths.rb
 - lib/google/cloud/data_catalog/v1/version.rb
+- lib/google/cloud/datacatalog/v1/bigquery_pb.rb
 - lib/google/cloud/datacatalog/v1/common_pb.rb
 - lib/google/cloud/datacatalog/v1/data_source_pb.rb
 - lib/google/cloud/datacatalog/v1/datacatalog_pb.rb
@@ -220,9 +221,11 @@ files:
 - lib/google/cloud/datacatalog/v1/table_spec_pb.rb
 - lib/google/cloud/datacatalog/v1/tags_pb.rb
 - lib/google/cloud/datacatalog/v1/timestamps_pb.rb
+- lib/google/cloud/datacatalog/v1/usage_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/datacatalog/v1/bigquery.rb
 - proto_docs/google/cloud/datacatalog/v1/common.rb
 - proto_docs/google/cloud/datacatalog/v1/data_source.rb
 - proto_docs/google/cloud/datacatalog/v1/datacatalog.rb
@@ -234,6 +237,7 @@ files:
 - proto_docs/google/cloud/datacatalog/v1/table_spec.rb
 - proto_docs/google/cloud/datacatalog/v1/tags.rb
 - proto_docs/google/cloud/datacatalog/v1/timestamps.rb
+- proto_docs/google/cloud/datacatalog/v1/usage.rb
 - proto_docs/google/iam/v1/iam_policy.rb
 - proto_docs/google/iam/v1/options.rb
 - proto_docs/google/iam/v1/policy.rb