google-cloud-bigquery-storage 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 190b95623adf543cff9427204f3c3cf4216f1b42aff35c2f32e896a8121d2435
-  data.tar.gz: 3e0c055f1aee767f7a1ace8469a7f0e0b5e67111ed4e1bc00906efc5b7fb4edf
+  metadata.gz: 7ffb54690da553bfb8cb1f8ee9b947df40ddfea5d74dcbde090ce85cf3069ea7
+  data.tar.gz: f98393db9b5b3a7def20a894dac243590e1e7187a1cb8bf2b838205a312e396f
 SHA512:
-  metadata.gz: 9d74cad3ec9bc02c8550f9c7aa6bae128939e3d153bbbc48e02b79dd507cc35012e8a90e6f268e271c41a488154076a11c6dd6347cb40b3a1347e186536c2ec9
-  data.tar.gz: be23137193b1dd83c0ed5cdffc184507a26782c402c3d16ba61ba0e2e05e661d3bf26766b121bf165597014a0000d4f1314a14bca3caababcd5aad92a4b91734
+  metadata.gz: 5e4b4a2de03fdaaab6f17d201272d9bb69f6a9c22c3e37dc01b4a466a342ac20b31a02098325f4a8b188f8b0e7bd04ac2f010b2e7e46e6698b7c6fa0c99ecd22
+  data.tar.gz: 0e3e74e8d6040e0a9be1196995d946e3246d806082b68661aa643a97fd3fa38fc986cfed6751210c32541c122caca98ab780304360752d1876db4101ab41dbd7

data/README.md

@@ -34,35 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/bigquerystorage.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
-end
-```
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-bigquery-storage-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-bigquery-storage-v1/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Bigquery
       module Storage
-        VERSION = "1.5.0"
+        VERSION = "1.6.0"
       end
     end
   end

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

@@ -57,6 +57,11 @@ module Google
         # supported by that API version, and the corresponding gem is available, the
         # appropriate versioned client will be returned.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the BigQueryRead service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Bigquery::Storage.big_query_read_available?}.
+        #
         # ## About BigQueryRead
         #
         # BigQuery Read API.
@@ -78,6 +83,32 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the BigQueryRead service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::Bigquery::Storage.big_query_read}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the BigQueryRead service,
+        # or if the versioned client gem needs an update to support the BigQueryRead service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.big_query_read_available? version: :v1
+          require "google/cloud/bigquery/storage/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Bigquery::Storage
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Bigquery::Storage.const_get package_name
+          return false unless service_module.const_defined? :BigQueryRead
+          service_module = service_module.const_get :BigQueryRead
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Create a new client object for BigQueryWrite.
         #
@@ -89,6 +120,11 @@ module Google
         # supported by that API version, and the corresponding gem is available, the
         # appropriate versioned client will be returned.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the BigQueryWrite service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Bigquery::Storage.big_query_write_available?}.
+        #
         # ## About BigQueryWrite
         #
         # BigQuery Write API.
@@ -113,6 +149,32 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the BigQueryWrite service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::Bigquery::Storage.big_query_write}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the BigQueryWrite service,
+        # or if the versioned client gem needs an update to support the BigQueryWrite service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.big_query_write_available? version: :v1
+          require "google/cloud/bigquery/storage/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Bigquery::Storage
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Bigquery::Storage.const_get package_name
+          return false unless service_module.const_defined? :BigQueryWrite
+          service_module = service_module.const_get :BigQueryWrite
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Configure the google-cloud-bigquery-storage library.
         #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-storage
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-bigquery-storage-v1
@@ -61,7 +60,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the BigQuery Storage API
 test_files: []