google-cloud-data_catalog-v1beta1 0.a → 0.2.0

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 V1beta1
+        # Describes a BigQuery table.
+        # @!attribute [r] table_source_type
+        #   @return [::Google::Cloud::DataCatalog::V1beta1::TableSourceType]
+        #     Output only. The table source type.
+        # @!attribute [rw] view_spec
+        #   @return [::Google::Cloud::DataCatalog::V1beta1::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::V1beta1::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
+
+          # BigQuery materialized view.
+          BIGQUERY_MATERIALIZED_VIEW = 7
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 V1beta1
+        # Tags are used to attach custom metadata to Data Catalog resources. Tags
+        # conform to the specifications within 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.
+        #     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::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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 Google Cloud 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.
+        # @!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::V1beta1::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::V1beta1::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::V1beta1::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] 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.  A higher value indicates 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::V1beta1::FieldType::PrimitiveType]
+        #     Represents primitive types - string, bool etc.
+        # @!attribute [rw] enum_type
+        #   @return [::Google::Cloud::DataCatalog::V1beta1::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::V1beta1::FieldType::EnumType::EnumValue>]
+          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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 V1beta1
+        # Timestamps about this resource according to a particular system.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The creation time 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.
+        # @!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.
+        class SystemTimestamps
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 V1beta1
+        # Detailed counts on the entry's usage.
+        # Caveats:
+        # - Only BigQuery tables have usage stats
+        # - The usage stats only include BigQuery query jobs
+        # - The usage stats might be underestimated, e.g. wildcard table references
+        # are not yet counted in usage computation
+        # https://cloud.google.com/bigquery/docs/querying-wildcard-tables
+        # @!attribute [rw] total_completions
+        #   @return [::Float]
+        #     The number of times that the underlying entry was successfully used.
+        # @!attribute [rw] total_failures
+        #   @return [::Float]
+        #     The number of times that the underlying entry was attempted to be used
+        #     but failed.
+        # @!attribute [rw] total_cancellations
+        #   @return [::Float]
+        #     The number of times that the underlying entry was attempted to be used
+        #     but was cancelled by the user.
+        # @!attribute [rw] total_execution_time_for_completions_millis
+        #   @return [::Float]
+        #     Total time spent (in milliseconds) during uses the resulted in completions.
+        class UsageStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The set of all usage signals that we store in Data Catalog.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp of the end of the usage statistics duration.
+        # @!attribute [rw] usage_within_time_range
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::UsageStats}]
+        #     Usage statistics over each of the pre-defined time ranges, supported
+        #     strings for 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::V1beta1::UsageStats]
+          class UsageWithinTimeRangeEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    class Empty
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end