google-cloud-bigquery 1.41.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f13891ae7f46f3a0561140fabe4eed4cc426923258e17ed4cc10cc8155f9129
-  data.tar.gz: 65eb5cfc6fb0feadae0d4503bcf2bd1942a0a9740a6f4f1b6f6aaddf7ee244c0
+  metadata.gz: 779c0f4690b370db6eb7811fa6fb8dbca101dff34ff478dcdc51ed1e9c83c083
+  data.tar.gz: d1456024ae30a18c93c05d6d8be7eef88dd3f0610cdbf816cf0c46322c9574be
 SHA512:
-  metadata.gz: cecf4d1450deb04f33772ebc0bf18892816dda84e9e2b43668615dc37c49b3319465c3d0f3cb9c07ca9cc5a5e7a7118daab1f1aa51c25bf83ebadc925bd52eef
-  data.tar.gz: c678e3b5420f82894c1d4935f4f89959fda4ea6e66faffa7fb649c0ff3c0e2fec91daf3e77208e02eb4747cf1a3d41ef5764a4b4da8b76b2a03328861121c7c2
+  metadata.gz: 6a5da0e2565b0c224f46a6330d138c8fb35831e874ebc2364fd3b91578d400354011d1e9df7d2986dbe2398f610776b130b7eb9305af8282bf3a6265dd84aa05
+  data.tar.gz: 0d14faa0d89ba6a114e247c362f8a5d4775ae4dc19de1aad0a64083da7e41fc93ac810e876b434056340b27412bb08063af05edf33355800ca1c528ff02f437b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 1.42.0 (2023-01-15)
+
+#### Features
+
+* Added support for authorized dataset ([#19442](https://github.com/googleapis/google-cloud-ruby/issues/19442)) 
+* Added support for tags in dataset ([#19350](https://github.com/googleapis/google-cloud-ruby/issues/19350)) 
+
 ### 1.41.0 (2023-01-05)
 
 #### Features

data/lib/google/cloud/bigquery/dataset/access.rb

@@ -61,8 +61,10 @@ module Google
             "user"           => :user_by_email,
             "user_by_email"  => :user_by_email,
             "userByEmail"    => :user_by_email,
-            "view"           => :view
+            "view"           => :view,
+            "dataset"        => :dataset
           }.freeze
+          attr_reader :rules
 
           # @private
           GROUPS = {
@@ -267,6 +269,44 @@ module Google
             add_access_view view
           end
 
+          ##
+          # Add reader access to a dataset.
+          #
+          # @param [Google::Cloud::Bigquery::DatasetAccessEntry, Hash<String,String> ] dataset A DatasetAccessEntry
+          #   or a Hash object. Required
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   params = {
+          #     dataset_id: other_dataset.dataset_id,
+          #     project_id: other_dataset.project_id,
+          #     target_types: ["VIEWS"]
+          #   }
+          #
+          #   dataset.access do |access|
+          #     access.add_reader_dataset params
+          #   end
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   dataset.access do |access|
+          #     access.add_reader_dataset other_dataset.access_entry(target_types: ["VIEWS"])
+          #   end
+          #
+          def add_reader_dataset dataset
+            add_access_dataset dataset
+          end
+
           ##
           # Add writer access to a user.
           #
@@ -610,6 +650,44 @@ module Google
             remove_access_view view
           end
 
+          ##
+          # Removes reader access of a dataset.
+          #
+          # @param [Google::Cloud::Bigquery::DatasetAccessEntry, Hash<String,String> ] dataset A DatasetAccessEntry
+          #   or a Hash object. Required
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   params = {
+          #     dataset_id: other_dataset.dataset_id,
+          #     project_id: other_dataset.project_id,
+          #     target_types: ["VIEWS"]
+          #   }
+          #
+          #   dataset.access do |access|
+          #     access.remove_reader_dataset params
+          #   end
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   dataset.access do |access|
+          #     access.remove_reader_dataset other_dataset.access_entry(target_types: ["VIEWS"])
+          #   end
+          #
+          def remove_reader_dataset dataset
+            remove_access_dataset dataset
+          end
+
           ##
           # Remove writer access from a user.
           #
@@ -951,6 +1029,40 @@ module Google
             lookup_access_view view
           end
 
+          ##
+          # Checks reader access for a dataset.
+          #
+          # @param [Google::Cloud::Bigquery::DatasetAccessEntry, Hash<String,String> ] dataset A DatasetAccessEntry
+          #   or a Hash object. Required
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   params = {
+          #     dataset_id: other_dataset.dataset_id,
+          #     project_id: other_dataset.project_id,
+          #     target_types: ["VIEWS"]
+          #   }
+          #
+          #   dataset.access.reader_dataset? params
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   other_dataset = bigquery.dataset "my_other_dataset", skip_lookup: true
+          #
+          #   dataset.access.reader_dataset? other_dataset.access_entry(target_types: ["VIEWS"])
+          #
+          def reader_dataset? dataset
+            lookup_access_dataset dataset
+          end
+
           ##
           # Checks writer access for a user.
           #
@@ -1184,6 +1296,18 @@ module Google
             end
           end
 
+          # @private
+          #
+          # Checks the type of user input and converts it to acceptable format.
+          #
+          def validate_dataset dataset
+            if dataset.is_a? Google::Apis::BigqueryV2::DatasetAccessEntry
+              dataset
+            else
+              Service.dataset_access_entry_from_hash dataset
+            end
+          end
+
           # @private
           def add_access_role_scope_value role, scope, value
             role = validate_role role
@@ -1218,6 +1342,17 @@ module Google
             @rules << Google::Apis::BigqueryV2::Dataset::Access.new(**opts)
           end
 
+          # @private
+          def add_access_dataset dataset
+            # scope is dataset, make sure value is in the right format
+            value = validate_dataset dataset
+            # Remove existing rule for input dataset, if any
+            @rules.reject!(&find_by_scope_and_resource_ref(:dataset, value))
+            # Add new rule for this role, scope, and value
+            opts = { dataset: value }
+            @rules << Google::Apis::BigqueryV2::Dataset::Access.new(**opts)
+          end
+
           # @private
           def remove_access_role_scope_value role, scope, value
             role = validate_role role
@@ -1244,6 +1379,14 @@ module Google
             @rules.reject!(&find_by_scope_and_resource_ref(:view, value))
           end
 
+          # @private
+          def remove_access_dataset dataset
+            # scope is dataset, make sure value is in the right format
+            value = validate_dataset dataset
+            # Remove existing rule for input dataset, if any
+            @rules.reject!(&find_by_scope_and_resource_ref(:dataset, value))
+          end
+
           # @private
           def lookup_access_role_scope_value role, scope, value
             role = validate_role role
@@ -1268,6 +1411,14 @@ module Google
             !(!@rules.detect(&find_by_scope_and_resource_ref(:view, value)))
           end
 
+          # @private
+          def lookup_access_dataset dataset
+            # scope is dataset, make sure value is in the right format
+            value = validate_dataset dataset
+            # Detect existing rule for input dataset, if any
+            !(!@rules.detect(&find_by_scope_and_resource_ref(:dataset, value)))
+          end
+
           # @private
           def find_by_role_and_scope_and_value role, scope, value
             lambda do |a|

data/lib/google/cloud/bigquery/dataset/tag.rb

@@ -0,0 +1,67 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/bigquery_v2"
+
+module Google
+  module Cloud
+    module Bigquery
+      class Dataset
+        ##
+        # A global tag managed by Resource Manager.
+        #
+        # @see https://cloud.google.com/iam/docs/tags-access-control#definitions
+        #
+        class Tag
+          ##
+          # @private The Google API Client object.
+          attr_accessor :gapi
+
+          ##
+          # @private Create an empty Tag object.
+          def initialize
+            @gapi = Google::Apis::BigqueryV2::Dataset::Tag.new
+          end
+
+          ##
+          # The namespaced friendly name of the tag key, e.g. "12345/environment" where
+          # 12345 is org id.
+          #
+          # @return [String]
+          #
+          def tag_key
+            @gapi.tag_key
+          end
+
+          ##
+          # The friendly short name of the tag value, e.g. "production".
+          #
+          # @return [String]
+          #
+          def tag_value
+            @gapi.tag_value
+          end
+
+          ##
+          # @private Google API Client object.
+          def self.from_gapi gapi
+            new_tag = new
+            new_tag.instance_variable_set :@gapi, gapi
+            new_tag
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/bigquery/dataset.rb

@@ -22,6 +22,7 @@ require "google/cloud/bigquery/routine"
 require "google/cloud/bigquery/external"
 require "google/cloud/bigquery/dataset/list"
 require "google/cloud/bigquery/dataset/access"
+require "google/cloud/bigquery/dataset/tag"
 require "google/cloud/bigquery/convert"
 require "google/apis/bigquery_v2"
 
@@ -466,6 +467,21 @@ module Google
           access_builder.freeze
         end
 
+        ##
+        # Retrieves the tags associated with this dataset. Tag keys are
+        # globally unique, and managed via the resource manager API.
+        #
+        # @see https://cloud.google.com/resource-manager/docs/tags/tags-overview
+        # for more information.
+        #
+        # @return [Google::Cloud::Bigquery::Dataset::Tag] The list of tags.
+        #
+        def tags
+          ensure_full_data!
+          return nil if @gapi.tags.nil?
+          @gapi.tags.map { |gapi| Tag.from_gapi(gapi) }
+        end
+
         ##
         # Permanently deletes the dataset. The dataset must be empty before it
         # can be deleted unless the `force` option is set to `true`.
@@ -2741,6 +2757,29 @@ module Google
                              interval: interval, threads: threads, &block
         end
 
+        ##
+        # Build an object of type Google::Apis::BigqueryV2::DatasetAccessEntry from
+        # the self.
+        #
+        # @param [Array<String>] target_types The list of target types within the dataset.
+        #
+        # @return [Google::Apis::BigqueryV2::DatasetAccessEntry] Returns a DatasetAccessEntry object.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   dataset_access_entry = dataset.access_entry target_types: ["VIEWS"]
+        #
+        def build_access_entry target_types: nil
+          params = {
+            dataset: dataset_ref,
+            target_types: target_types
+          }.delete_if { |_, v| v.nil? }
+          Google::Apis::BigqueryV2::DatasetAccessEntry.new(**params)
+        end
+
         protected
 
         def insert_data_with_autocreate table_id, rows, skip_invalid: nil, ignore_unknown: nil, insert_ids: nil

data/lib/google/cloud/bigquery/service.rb

@@ -497,6 +497,19 @@ module Google
           ref
         end
 
+        ##
+        # Converts a hash to a Google::Apis::BigqueryV2::DatasetAccessEntry oject.
+        #
+        # @param [Hash<String,String>] dataset_hash Hash for a DatasetAccessEntry.
+        #
+        def self.dataset_access_entry_from_hash dataset_hash
+          params = {
+            dataset: Google::Apis::BigqueryV2::DatasetReference.new(**dataset_hash),
+            target_types: dataset_hash[:target_types]
+          }.delete_if { |_, v| v.nil? }
+          Google::Apis::BigqueryV2::DatasetAccessEntry.new(**params)
+        end
+
         def self.validate_table_ref table_ref
           [:project_id, :dataset_id, :table_id].each do |f|
             raise ArgumentError, "TableReference is missing #{f}" if table_ref.send(f).nil?

data/lib/google/cloud/bigquery/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigquery
-      VERSION = "1.41.0".freeze
+      VERSION = "1.42.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -268,6 +268,7 @@ files:
 - lib/google/cloud/bigquery/dataset.rb
 - lib/google/cloud/bigquery/dataset/access.rb
 - lib/google/cloud/bigquery/dataset/list.rb
+- lib/google/cloud/bigquery/dataset/tag.rb
 - lib/google/cloud/bigquery/encryption_configuration.rb
 - lib/google/cloud/bigquery/external.rb
 - lib/google/cloud/bigquery/external/avro_source.rb
@@ -320,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google BigQuery