google-cloud-bigquery-data_exchange 0.4.1 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2de36842952d8f566128f0f6104eb5b0aa2446c2787725330bd611bdd53efa48
4
- data.tar.gz: 1782c8ea877ee4c1237bbbf80f269a210d48211d3c39dd2c38970207bc4631fd
3
+ metadata.gz: d3a1bfad1befd1cfbad753b95746c2bd4ac235a0a9a5e7b436258251a232f574
4
+ data.tar.gz: ddcfb5379ec40ba93022c96649bd9a8cb43a9802513ca970c3e8816fe0634476
5
5
  SHA512:
6
- metadata.gz: ff515755737d5569eff4af86c3ea8438acf74369d1e90f725bbe1679996e82fca3c15bc439b4ba5292aa3f92ccf2242d417cc6e0fc2a19b073b44cdec23acb10
7
- data.tar.gz: cb6625c65686d360c13ff27c8bef7332eda362c1949d934a00dafeb2e7f64c4762de72b788c58293d6805a7a0e03bbf1e1ab6d475c8e9452ca90a12bbaaf42fb
6
+ metadata.gz: ccb68338150674550351b86bd6544046edda01ae3ee62d8e44e1a4f05713999942fad5d73ebc71423414a14f1697cc41f62e3f1be06600066ae18a15b1a17637
7
+ data.tar.gz: 6e15ddc066d5dc75f3134f077b52de4053026c6262e3999c6ad72bdde7ab0fb0eaf21a5a5b7e2c5ab474f83740cbf63f6edf692a2b123b24593ebcf27e4dc0c6
data/README.md CHANGED
@@ -7,7 +7,7 @@ Analytics Hub is a data exchange that allows you to efficiently and securely exc
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-bigquery-data_exchange-v*`.
9
9
  The gem `google-cloud-bigquery-data_exchange` is the main client library that brings the
10
- verisoned gems in as dependencies, and provides high-level methods for
10
+ versioned gems in as dependencies, and provides high-level methods for
11
11
  constructing clients. More information on versioned clients can be found below
12
12
  in the section titled *Which client should I use?*.
13
13
 
@@ -34,35 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/analyticshub.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
42
- 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)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-bigquery-data_exchange-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-bigquery-data_exchange-v1beta1/latest).
62
66
 
63
67
  ## Supported Ruby Versions
64
68
 
65
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
66
70
 
67
71
  Google provides official support for Ruby versions that are actively supported
68
72
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Bigquery
23
23
  module DataExchange
24
- VERSION = "0.4.1"
24
+ VERSION = "0.5.1"
25
25
  end
26
26
  end
27
27
  end
@@ -57,6 +57,11 @@ module Google
57
57
  # supported by that API version, and the corresponding gem is available, the
58
58
  # appropriate versioned client will be returned.
59
59
  #
60
+ # Raises an exception if the currently installed versioned client gem for the
61
+ # given API version does not support the AnalyticsHubService service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::Bigquery::DataExchange.analytics_hub_service_available?}.
64
+ #
60
65
  # ## About AnalyticsHubService
61
66
  #
62
67
  # The `AnalyticsHubService` API facilitates data sharing within and across
@@ -81,6 +86,32 @@ module Google
81
86
  service_module.const_get(:Client).new(&block)
82
87
  end
83
88
 
89
+ ##
90
+ # Determines whether the AnalyticsHubService service is supported by the current client.
91
+ # If true, you can retrieve a client object by calling {Google::Cloud::Bigquery::DataExchange.analytics_hub_service}.
92
+ # If false, that method will raise an exception. This could happen if the given
93
+ # API version does not exist or does not support the AnalyticsHubService service,
94
+ # or if the versioned client gem needs an update to support the AnalyticsHubService service.
95
+ #
96
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
97
+ # Defaults to `:v1beta1`.
98
+ # @return [boolean] Whether the service is available.
99
+ #
100
+ def self.analytics_hub_service_available? version: :v1beta1
101
+ require "google/cloud/bigquery/data_exchange/#{version.to_s.downcase}"
102
+ package_name = Google::Cloud::Bigquery::DataExchange
103
+ .constants
104
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
105
+ .first
106
+ return false unless package_name
107
+ service_module = Google::Cloud::Bigquery::DataExchange.const_get package_name
108
+ return false unless service_module.const_defined? :AnalyticsHubService
109
+ service_module = service_module.const_get :AnalyticsHubService
110
+ service_module.const_defined? :Client
111
+ rescue ::LoadError
112
+ false
113
+ end
114
+
84
115
  ##
85
116
  # Configure the google-cloud-bigquery-data_exchange library.
86
117
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-data_exchange
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.1
4
+ version: 0.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-09 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-bigquery-data_exchange-v1beta1
@@ -64,7 +63,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
64
63
  licenses:
65
64
  - Apache-2.0
66
65
  metadata: {}
67
- post_install_message:
68
66
  rdoc_options: []
69
67
  require_paths:
70
68
  - lib
@@ -72,15 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
72
70
  requirements:
73
71
  - - ">="
74
72
  - !ruby/object:Gem::Version
75
- version: '2.7'
73
+ version: '3.0'
76
74
  required_rubygems_version: !ruby/object:Gem::Requirement
77
75
  requirements:
78
76
  - - ">="
79
77
  - !ruby/object:Gem::Version
80
78
  version: '0'
81
79
  requirements: []
82
- rubygems_version: 3.5.6
83
- signing_key:
80
+ rubygems_version: 3.6.8
84
81
  specification_version: 4
85
82
  summary: API Client library for the Analytics Hub API
86
83
  test_files: []