google-cloud-data_catalog-v1 0.1.0

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+        # Describes a Cloud Storage fileset entry.
+        # @!attribute [rw] file_patterns
+        #   @return [Array<String>]
+        #     Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud
+        #     Storage documentation](/storage/docs/gsutil/addlhelp/WildcardNames) for
+        #     more information. Note that bucket wildcards are currently not supported.
+        #
+        #     Examples of valid file_patterns:
+        #
+        #      * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir`
+        #                                  directory.
+        #      * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
+        #                                   spanning all subdirectories.
+        #      * `gs://bucket_name/file*`: matches files prefixed by `file` in
+        #                                  `bucket_name`
+        #      * `gs://bucket_name/??.txt`: matches files with two characters followed by
+        #                                   `.txt` in `bucket_name`
+        #      * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
+        #                                        vowel character followed by `.txt` in
+        #                                        `bucket_name`
+        #      * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
+        #                                      or `m` followed by `.txt` in `bucket_name`
+        #      * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
+        #                                  `a/*/b` pattern, such as `a/c/b`, `a/d/b`
+        #      * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
+        #
+        #     You can combine wildcards to provide more powerful matches, for example:
+        #
+        #      * `gs://bucket_name/[a-m]??.j*g`
+        # @!attribute [r] sample_gcs_file_specs
+        #   @return [Array<Google::Cloud::DataCatalog::V1::GcsFileSpec>]
+        #     Output only. Sample files contained in this fileset, not all files
+        #     contained in this fileset are represented here.
+        class GcsFilesetSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifications of a single file in Cloud Storage.
+        # @!attribute [rw] file_path
+        #   @return [String]
+        #     Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
+        # @!attribute [r] gcs_timestamps
+        #   @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
+        #     Output only. Timestamps about the Cloud Storage file.
+        # @!attribute [r] size_bytes
+        #   @return [Integer]
+        #     Output only. The size of the file, in bytes.
+        class GcsFileSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+        # 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.
+        class Schema
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Representation of a column within a schema. Columns could be nested inside
+        # other columns.
+        # @!attribute [rw] column
+        #   @return [String]
+        #     Required. Name of the column.
+        # @!attribute [rw] type
+        #   @return [String]
+        #     Required. Type of the column.
+        # @!attribute [rw] description
+        #   @return [String]
+        #     Optional. Description of the column. Default value is an empty string.
+        # @!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.
+        #     Default mode is `NULLABLE`.
+        # @!attribute [rw] subcolumns
+        #   @return [Array<Google::Cloud::DataCatalog::V1::ColumnSchema>]
+        #     Optional. Schema of sub-columns. A column can have zero or more sub-columns.
+        class ColumnSchema
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 result that appears in the response of 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.
+        # @!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`.
+        # @!attribute [rw] relative_resource_name
+        #   @return [String]
+        #     The relative resource 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}`
+        # @!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.
+        #     Example:
+        #
+        #      * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
+        # @!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.
+        # @!attribute [rw] user_specified_system
+        #   @return [String]
+        #     This field indicates the entry's source system that Data Catalog does not
+        #     integrate with.
+        class SearchCatalogResult
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The different types of resources that can be returned in search.
+        module SearchResultType
+          # Default unknown type.
+          SEARCH_RESULT_TYPE_UNSPECIFIED = 0
+
+          # An {Google::Cloud::DataCatalog::V1::Entry Entry}.
+          ENTRY = 1
+
+          # A {Google::Cloud::DataCatalog::V1::TagTemplate TagTemplate}.
+          TAG_TEMPLATE = 2
+
+          # An {Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
+          ENTRY_GROUP = 3
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+        # Describes a BigQuery table.
+        # @!attribute [r] table_source_type
+        #   @return [Google::Cloud::DataCatalog::V1::TableSourceType]
+        #     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`.
+        # @!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`.
+        class BigQueryTableSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Table view specification.
+        # @!attribute [r] view_query
+        #   @return [String]
+        #     Output only. The query that defines the table view.
+        class ViewSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Normal BigQuery table spec.
+        # @!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}`.
+        #     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
+        # @!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}`.
+        # @!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
+        #     `table_prefix` is `MyTable`.
+        # @!attribute [r] shard_count
+        #   @return [Integer]
+        #     Output only. Total number of shards.
+        class BigQueryDateShardedSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Table source type.
+        module TableSourceType
+          # Default unknown type.
+          TABLE_SOURCE_TYPE_UNSPECIFIED = 0
+
+          # Table view.
+          BIGQUERY_VIEW = 2
+
+          # BigQuery native table.
+          BIGQUERY_TABLE = 5
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+        # Tags are used to attach custom metadata to Data Catalog resources. Tags
+        # conform to the specifications within their tag template.
+        #
+        # See [Data Catalog IAM](/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.
+        #     Note that this Tag may not actually be stored in the location in this name.
+        # @!attribute [rw] template
+        #   @return [String]
+        #     Required. The resource name of the tag template that this tag uses. Example:
+        #
+        #     * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
+        #
+        #     This field cannot be modified after creation.
+        # @!attribute [r] template_display_name
+        #   @return [String]
+        #     Output only. The display name of the tag template.
+        # @!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.
+        #
+        #     For attaching a tag to a nested column, use `.` to separate the column
+        #     names. Example:
+        #
+        #     * `outer_column.inner_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
+        #     must have at least 1 field and at most 500 fields.
+        class Tag
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [String]
+          # @!attribute [rw] value
+          #   @return [Google::Cloud::DataCatalog::V1::TagField]
+          class FieldsEntry
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Contains the value and supporting information for 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.
+        # @!attribute [rw] string_value
+        #   @return [String]
+        #     Holds the value for a tag field with string type.
+        # @!attribute [rw] bool_value
+        #   @return [Boolean]
+        #     Holds the value for a tag field with boolean type.
+        # @!attribute [rw] timestamp_value
+        #   @return [Google::Protobuf::Timestamp]
+        #     Holds the value for a tag field with 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.
+        # @!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.
+        class TagField
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Holds an enum value.
+          # @!attribute [rw] display_name
+          #   @return [String]
+          #     The display name of the enum value.
+          class EnumValue
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          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](/iam/docs/understanding-roles#data-catalog-roles)
+        # provide permissions to create, edit, and use the template. See, for example,
+        # the [TagTemplate User](/data-catalog/docs/how-to/template-user) role, which
+        # includes 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}
+        #
+        #     Note that this TagTemplate and its child resources may not actually be
+        #     stored in the location in this name.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     The display name for this template. Defaults to an empty string.
+        # @!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
+        #     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.
+        class TagTemplate
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [String]
+          # @!attribute [rw] value
+          #   @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
+          class FieldsEntry
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The template for an individual field within a tag template.
+        # @!attribute [r] name
+        #   @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}
+        #
+        #     Note that this TagTemplateField may not actually be stored in the location
+        #     in this name.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     The display name for this field. Defaults to an empty string.
+        # @!attribute [rw] type
+        #   @return [Google::Cloud::DataCatalog::V1::FieldType]
+        #     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.
+        # @!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.
+        class TagTemplateField
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] primitive_type
+        #   @return [Google::Cloud::DataCatalog::V1::FieldType::PrimitiveType]
+        #     Represents primitive types - string, bool etc.
+        # @!attribute [rw] enum_type
+        #   @return [Google::Cloud::DataCatalog::V1::FieldType::EnumType]
+        #     Represents an enum type.
+        class FieldType
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] allowed_values
+          #   @return [Array<Google::Cloud::DataCatalog::V1::FieldType::EnumType::EnumValue>]
+          #     Required on create; optional on update. The set of allowed values for
+          #     this enum. This set must not be empty, the display names of the values in
+          #     this set must not be empty and the display names of the values must be
+          #     case-insensitively unique within this set. Currently, enum values can
+          #     only be added to the list of allowed values. Deletion and renaming of
+          #     enum values are not supported. Can have up to 500 allowed values.
+          class EnumType
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] display_name
+            #   @return [String]
+            #     Required. The display name of the enum value. Must not be an empty string.
+            class EnumValue
+              include Google::Protobuf::MessageExts
+              extend Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          module PrimitiveType
+            # This is the default invalid value for a type.
+            PRIMITIVE_TYPE_UNSPECIFIED = 0
+
+            # A double precision number.
+            DOUBLE = 1
+
+            # An UTF-8 string.
+            STRING = 2
+
+            # A boolean value.
+            BOOL = 3
+
+            # A timestamp.
+            TIMESTAMP = 4
+          end
+        end
+      end
+    end
+  end
+end