google-cloud-bigquery 1.57.0 → 1.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe17241cff1bf35169627f5be2bc589b24e4830077b1966192d74cb478efcc0
-  data.tar.gz: a6060857441bd335b1a8c67509f742d586026e043269d48893c22e4ffe3a3b9f
+  metadata.gz: 7eb6ceb935eefe0881476f99a5f6e7bdf85e42debb251ba34ef999a3845ca3ef
+  data.tar.gz: 71cb8fa56300a051b257e77fb332fee37a18044fb26317a3e0eebbb57023144d
 SHA512:
-  metadata.gz: 361370e039788d37aaebe2c3dc368e3715e7f09c65ffc85727285c1cdfe608412e09352570e3f1c88abb52b52c851646540c67e3c023c344ef1d8f37cab78086
-  data.tar.gz: 8b86e329d6843a4d4387f1c1daf1ed3feaabe47284ad4e8320ce3c9e39a492fadbecfe46006e1b0a38fedbe94250795aa0968a2148c94e0f1bf25a4514ad2d92
+  metadata.gz: 70305f4088f9af6ad6823f07e9326a5db55e2abfd17094d4a3d52ae1dd85dae871df5acaec43b9163130f7cbe226a3339dbcef96bbf181fdbafcbbdfca70bcb8
+  data.tar.gz: 93f2a24709c74dae96f6732ee36d328f9f46e9cecb63f87ac1da70d9e37d1a4d03c452ae4c4a772b31adb5145cb53157f4d14869d54f0131208ac2060551cb19

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 1.58.0 (2025-09-03)
+
+#### Features
+
+* Add support for remote function options ([#30822](https://github.com/googleapis/google-cloud-ruby/issues/30822)) 
+
 ### 1.57.0 (2025-08-28)
 
 #### Features

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

@@ -0,0 +1,156 @@
+# Copyright 2025 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.
+
+module Google
+  module Cloud
+    module Bigquery
+      ##
+      # # RemoteFunctionOptions
+      #
+      # Options for a remote user-defined function.
+      #
+      class RemoteFunctionOptions
+        ##
+        # @private The Google API Client object.
+        # @return [Google::Apis::BigqueryV2::RemoteFunctionOptions]
+        attr_accessor :gapi
+
+        ##
+        # Creates a new RemoteFunctionOptions object.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   remote_function_options = Google::Cloud::Bigquery::RemoteFunctionOptions.new.tap do |rfo|
+        #     rfo.endpoint = "https://us-east1-my_gcf_project.cloudfunctions.net/remote_add"
+        #     rfo.connection = "projects/my-project/locations/us-east1/connections/my-connection"
+        #     rfo.user_defined_context = { "foo" => "bar" }
+        #   end
+        #
+        def initialize
+          @gapi = Google::Apis::BigqueryV2::RemoteFunctionOptions.new
+        end
+
+        ##
+        # The endpoint of the user-provided remote service, e.g.
+        # `https://us-east1-my_gcf_project.cloudfunctions.net/remote_add`.
+        #
+        # @return [String] The endpoint of the user-provided remote service.
+        #   Returns an empty string if the endpoint is not configured.
+        #
+        def endpoint
+          @gapi.endpoint || ""
+        end
+
+        ##
+        # Sets the endpoint of the user-provided remote service.
+        #
+        # @param [String, nil] new_endpoint The new endpoint. Passing `nil` will
+        #   clear the endpoint, indicating that no remote service is configured.
+        #
+        def endpoint= new_endpoint
+          @gapi.endpoint = new_endpoint
+        end
+
+        ##
+        # The fully qualified name of the user-provided connection object which
+        # holds the authentication information to send requests to the remote
+        # service.
+        #
+        # Format:
+        # `projects/{projectId}/locations/{locationId}/connections/{connectionId}`
+        #
+        # @return [String] The fully qualified name of the user-provided
+        #   connection object. Returns an empty string if the connection is not
+        #   configured.
+        #
+        def connection
+          @gapi.connection || ""
+        end
+
+        ##
+        # Sets the fully qualified name of the user-provided connection object.
+        #
+        # @param [String, nil] new_connection The new connection. Passing `nil`
+        #   will clear the connection, indicating that no authentication
+        #   information is configured for the remote service.
+        #
+        def connection= new_connection
+          @gapi.connection = new_connection
+        end
+
+        ##
+        # User-defined context as a set of key/value pairs, which will be sent
+        # as function invocation context together with batched arguments in the
+        # requests to the remote service. The total number of bytes of keys and
+        # values must be less than 8KB.
+        #
+        # @return [Hash] The user-defined context. Returns an empty hash if no
+        #   context is configured.
+        #
+        def user_defined_context
+          @gapi.user_defined_context || {}
+        end
+
+        ##
+        # Sets the user-defined context.
+        #
+        # @param [Hash, nil] new_user_defined_context The new user-defined
+        #   context. Passing `nil` will clear the context, meaning no
+        #   user-defined key-value pairs will be sent.
+        #
+        def user_defined_context= new_user_defined_context
+          @gapi.user_defined_context = new_user_defined_context
+        end
+
+        ##
+        # Max number of rows in each batch sent to the remote service. If absent
+        # or if 0, BigQuery dynamically decides the number of rows in a batch.
+        #
+        # @return [Integer] Max number of rows in each batch. Returns `0` if not
+        #   set, which indicates that BigQuery dynamically decides the number of
+        #   rows.
+        #
+        def max_batching_rows
+          @gapi.max_batching_rows || 0
+        end
+
+        ##
+        # Sets the max number of rows in each batch sent to the remote service.
+        #
+        # @param [Integer, nil] new_max_batching_rows The new max batching rows.
+        #   Passing `nil` or `0` will reset the batch size, indicating that
+        #   BigQuery should dynamically decide the number of rows in each batch.
+        #
+        def max_batching_rows= new_max_batching_rows
+          @gapi.max_batching_rows = new_max_batching_rows
+        end
+
+        # @private New RemoteFunctionOptions from a Google API Client object.
+        def self.from_gapi gapi
+          return nil if gapi.nil?
+          new.tap do |rfo|
+            rfo.instance_variable_set :@gapi, gapi
+          end
+        end
+
+        ##
+        # @private Returns the Google API Client object.
+        def to_gapi
+          @gapi
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ require "google/cloud/bigquery/convert"
 require "google/cloud/bigquery/service"
 require "google/cloud/bigquery/routine/list"
 require "google/cloud/bigquery/argument"
+require "google/cloud/bigquery/remote_function_options"
 
 module Google
   module Cloud
@@ -743,6 +744,55 @@ module Google
           update_gapi!
         end
 
+        ##
+        # Remote function specific options. Optional.
+        #
+        # @return [RemoteFunctionOptions, nil] The remote function options, or `nil` if not set or the object is a
+        #   reference (see {#reference?}).
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   routine = dataset.routine "my_routine"
+        #
+        #   puts routine.remote_function_options.endpoint
+        #
+        # @!group Attributes
+        #
+        def remote_function_options
+          return nil if reference?
+          ensure_full_data!
+          RemoteFunctionOptions.from_gapi @gapi.remote_function_options
+        end
+
+        ##
+        # Updates the remote function specific options. Optional.
+        #
+        # @param [RemoteFunctionOptions] new_remote_function_options The new remote function options.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   routine = dataset.routine "my_routine"
+        #
+        #   rfo = Google::Cloud::Bigquery::RemoteFunctionOptions.new.tap do |rfo|
+        #     rfo.endpoint = "https://us-east1-my_gcf_project.cloudfunctions.net/remote_add"
+        #     rfo.connection = "projects/my-project/locations/us-east1/connections/my-connection"
+        #   end
+        #   routine.remote_function_options = rfo
+        #
+        # @!group Attributes
+        #
+        def remote_function_options= new_remote_function_options
+          ensure_full_data!
+          @gapi.remote_function_options = new_remote_function_options.to_gapi
+          update_gapi!
+        end
+
         ##
         # Updates the routine with changes made in the given block in a single update request. The following attributes
         # may be set: {Updater#routine_type=}, {Updater#language=}, {Updater#arguments=}, {Updater#return_type=},
@@ -1275,6 +1325,32 @@ module Google
             @gapi.data_governance_type = new_data_governance_type
           end
 
+          ##
+          # Updates the remote function specific options. Optional.
+          #
+          # @param [Google::Cloud::Bigquery::RemoteFunctionOptions] new_remote_function_options The new
+          #   remote function options.
+          #
+          # @example
+          #   require "google/cloud/bigquery"
+          #
+          #   bigquery = Google::Cloud::Bigquery.new
+          #   dataset = bigquery.dataset "my_dataset"
+          #   routine = dataset.routine "my_routine"
+          #
+          #   routine.update do |r|
+          #     rfo = Google::Cloud::Bigquery::RemoteFunctionOptions.new
+          #     rfo.endpoint = "https://us-east1-my_gcf_project.cloudfunctions.net/remote_add"
+          #     rfo.connection = "projects/my-project/locations/us-east1/connections/my-connection"
+          #     r.remote_function_options = rfo
+          #   end
+          #
+          # @!group Attributes
+          #
+          def remote_function_options= new_remote_function_options
+            @gapi.remote_function_options = new_remote_function_options.to_gapi
+          end
+
           def update
             raise "not implemented in #{self.class}"
           end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigquery
-      VERSION = "1.57.0".freeze
+      VERSION = "1.58.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.57.0
+  version: 1.58.0
 platform: ruby
 authors:
 - Mike Moore
@@ -165,6 +165,7 @@ files:
 - lib/google/cloud/bigquery/project.rb
 - lib/google/cloud/bigquery/project/list.rb
 - lib/google/cloud/bigquery/query_job.rb
+- lib/google/cloud/bigquery/remote_function_options.rb
 - lib/google/cloud/bigquery/routine.rb
 - lib/google/cloud/bigquery/routine/list.rb
 - lib/google/cloud/bigquery/schema.rb