google-cloud-data_catalog-v1 0.7.1 → 0.8.1

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DataCatalog
       module V1
-        # Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
+        # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
         # @!attribute [rw] columns
         #   @return [::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>]
         #     The unified GoogleSQL-like schema of columns.
@@ -33,7 +33,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Representation of a column within a schema. Columns could be nested inside
+        # A column within a schema. Columns can be nested inside
         # other columns.
         # @!attribute [rw] column
         #   @return [::String]
@@ -54,7 +54,7 @@ module Google
         #     bytes.
         # @!attribute [rw] mode
         #   @return [::String]
-        #     Optional. A column's mode indicates if values in this column are required,
+        #     Optional. A column's mode indicates whether values in this column are required,
         #     nullable, or repeated.
         #
         #     Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported.

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

@@ -21,60 +21,74 @@ module Google
   module Cloud
     module DataCatalog
       module V1
-        # A result that appears in the response of a search request. Each result
-        # captures details of one entry that matches the search.
+        # Result in the response to a search request.
+        #
+        # Each result captures details of one entry that matches the search.
         # @!attribute [rw] search_result_type
         #   @return [::Google::Cloud::DataCatalog::V1::SearchResultType]
-        #     Type of the search result. This field can be used to determine which Get
-        #     method to call to fetch the full resource.
+        #     Type of the search result.
+        #
+        #     You can use this field to determine which get method to call to fetch the
+        #     full resource.
         # @!attribute [rw] search_result_subtype
         #   @return [::String]
-        #     Sub-type of the search result. This is a dot-delimited description of the
-        #     resource's full type, and is the same as the value callers would provide in
-        #     the "type" search facet.  Examples: `entry.table`, `entry.dataStream`,
-        #     `tagTemplate`.
+        #     Sub-type of the search result.
+        #
+        #     A dot-delimited full type of the resource. The same type you
+        #     specify in the `type` search predicate.
+        #
+        #     Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.
         # @!attribute [rw] relative_resource_name
         #   @return [::String]
-        #     The relative resource name of the resource in URL format.
+        #     The relative name of the resource in URL format.
+        #
         #     Examples:
         #
-        #      * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
-        #      * `projects/{project_id}/tagTemplates/{tag_template_id}`
+        #      * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
+        #      * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`
         # @!attribute [rw] linked_resource
         #   @return [::String]
-        #     The full name of the cloud resource the entry belongs to. See:
-        #     https://cloud.google.com/apis/design/resource_names#full_resource_name.
+        #     The full name of the Google Cloud resource the entry belongs to.
+        #
+        #     For more information, see [Full Resource Name]
+        #     (/apis/design/resource_names#full_resource_name).
+        #
         #     Example:
         #
-        #      * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
+        #     `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
         # @!attribute [rw] modify_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Last-modified timestamp of the entry from the managing system.
+        #     The last modification timestamp of the entry in the source system.
         # @!attribute [r] integrated_system
         #   @return [::Google::Cloud::DataCatalog::V1::IntegratedSystem]
-        #     Output only. This field indicates the entry's source system that Data Catalog
-        #     integrates with, such as BigQuery or Cloud Pub/Sub.
+        #     Output only. The source system that Data Catalog automatically integrates  with, such
+        #     as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
         # @!attribute [rw] user_specified_system
         #   @return [::String]
-        #     This field indicates the entry's source system that Data Catalog does not
-        #     integrate with.
+        #     Custom source system that you can manually integrate Data Catalog with.
         # @!attribute [rw] fully_qualified_name
         #   @return [::String]
-        #     Fully Qualified Name of the resource.
-        #     There are two main forms of FQNs:
-        #     \\{system}:\\{project}.\\{dot-separated path to resource}
-        #         for non-regionalized resources
-        #     \\{system}:\\{project}.\\{location id}.\\{dot-separated path to resource}
-        #         for regionalized resources
-        #     Examples:
-        #     * dataproc_metastore:projectId.locationId.instanceId.databaseId.tableId
-        #     * bigquery:table.project_id.dataset_id.table_id
+        #     Fully qualified name (FQN) of the resource.
+        #
+        #     FQNs take two forms:
+        #
+        #     * For non-regionalized resources:
+        #
+        #       `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
+        #
+        #     * For regionalized resources:
+        #
+        #       `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
+        #
+        #     Example for a DPMS table:
+        #
+        #     `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`
         class SearchCatalogResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The different types of resources that can be returned in search.
+        # The resource types that can be returned in search results.
         module SearchResultType
           # Default unknown type.
           SEARCH_RESULT_TYPE_UNSPECIFIED = 0

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