google-cloud-notebooks 2.4.1 → 2.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2779f2c1d626dec2351bf82fd5bae043bc94bf649488524ca435d8104996dc3f
4
- data.tar.gz: 3dd5e151eb2d22552605ee7cccc09e8df0c25afc16e5e8e5db430fd6c65a5539
3
+ metadata.gz: 5bfe4ab5a9d3521b1ef78fff7ae6dfae9dd043e514b0b67e5bec4002e3ca3292
4
+ data.tar.gz: fcf6e79d32e60b2b94b0fe66a85937b37faf532802f2ce27a6b85eba1963b7ee
5
5
  SHA512:
6
- metadata.gz: ba0a65a23ec2295baacce4268891e7dd51dd3f305b841ef88056285bc868ad42b0895b95abe369f098cf65f597b6ec0a775ff5bd39d9ecfa0bc9bf946628d4fb
7
- data.tar.gz: ca067c405df986448dc1a6b9ace0c155bbc2dfc19f1d9142f496ca1b3236d30db80882711330d75b6a7954433d6b76936cc4258d0a017c1cbe21c88234697e9e
6
+ metadata.gz: c6499999ee0ec642da9c1675d7feac6294be24dc01be6b616cf0c35b8430910077ac14a1c683917fa868e85010c2138bdaa59c12e1551b40234232a819e025ba
7
+ data.tar.gz: f5a676dcc644d21037828f73b5e4a292516e77ef5d3561b8f1cdbb563288213ac23a51337b4897d4281fed8f0c568761e6fb5c6c1f8627ce710208caceec3805
data/README.md CHANGED
@@ -35,9 +35,40 @@ In order to use this library, you first need to go through the following steps:
35
35
  1. [Enable the API.](https://console.cloud.google.com/apis/library/notebooks.googleapis.com)
36
36
  1. {file:AUTHENTICATION.md Set up authentication.}
37
37
 
38
+ ## Debug Logging
39
+
40
+ This library comes with opt-in Debug Logging that can help you troubleshoot
41
+ your application's integration with the API. When logging is activated, key
42
+ events such as requests and responses, along with data payloads and metadata
43
+ such as headers and client configuration, are logged to the standard error
44
+ stream.
45
+
46
+ **WARNING:** Client Library Debug Logging includes your data payloads in
47
+ plaintext, which could include sensitive data such as PII for yourself or your
48
+ customers, private keys, or other security data that could be compromising if
49
+ leaked. Always practice good data hygiene with your application logs, and follow
50
+ the principle of least access. Google also recommends that Client Library Debug
51
+ Logging be enabled only temporarily during active debugging, and not used
52
+ permanently in production.
53
+
54
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
55
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
56
+ list of client library gem names. This will select the default logging behavior,
57
+ which writes logs to the standard error stream. On a local workstation, this may
58
+ result in logs appearing on the console. When running on a Google Cloud hosting
59
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
60
+ results in logs appearing alongside your application logs in the
61
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
62
+
63
+ Debug logging also requires that the versioned clients for this service be
64
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
65
+ working, try updating the versioned clients in your bundle or installed gems:
66
+ [google-cloud-notebooks-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1/latest),
67
+ [google-cloud-notebooks-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1beta1/latest).
68
+
38
69
  ## Supported Ruby Versions
39
70
 
40
- This library is supported on Ruby 2.7+.
71
+ This library is supported on Ruby 3.0+.
41
72
 
42
73
  Google provides official support for Ruby versions that are actively supported
43
74
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Notebooks
23
- VERSION = "2.4.1"
23
+ VERSION = "2.5.0"
24
24
  end
25
25
  end
26
26
  end
@@ -58,6 +58,11 @@ module Google
58
58
  # You can also specify a different transport by passing `:rest` or `:grpc` in
59
59
  # the `transport` parameter.
60
60
  #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the NotebookService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Notebooks.notebook_service_available?}.
65
+ #
61
66
  # ## About NotebookService
62
67
  #
63
68
  # API v1beta1 service for Cloud AI Platform Notebooks.
@@ -79,6 +84,37 @@ module Google
79
84
  service_module.const_get(:Client).new(&block)
80
85
  end
81
86
 
87
+ ##
88
+ # Determines whether the NotebookService service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::Notebooks.notebook_service}.
90
+ # If false, that method will raise an exception. This could happen if the given
91
+ # API version does not exist or does not support the NotebookService service,
92
+ # or if the versioned client gem needs an update to support the NotebookService service.
93
+ #
94
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
95
+ # Defaults to `:v1`.
96
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
97
+ # @return [boolean] Whether the service is available.
98
+ #
99
+ def self.notebook_service_available? version: :v1, transport: :grpc
100
+ require "google/cloud/notebooks/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::Notebooks
102
+ .constants
103
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
104
+ .first
105
+ return false unless package_name
106
+ service_module = Google::Cloud::Notebooks.const_get package_name
107
+ return false unless service_module.const_defined? :NotebookService
108
+ service_module = service_module.const_get :NotebookService
109
+ if transport == :rest
110
+ return false unless service_module.const_defined? :Rest
111
+ service_module = service_module.const_get :Rest
112
+ end
113
+ service_module.const_defined? :Client
114
+ rescue ::LoadError
115
+ false
116
+ end
117
+
82
118
  ##
83
119
  # Configure the google-cloud-notebooks library.
84
120
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-notebooks
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.4.1
4
+ version: 2.5.0
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: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-core
@@ -84,7 +83,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
84
83
  licenses:
85
84
  - Apache-2.0
86
85
  metadata: {}
87
- post_install_message:
88
86
  rdoc_options: []
89
87
  require_paths:
90
88
  - lib
@@ -92,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
92
90
  requirements:
93
91
  - - ">="
94
92
  - !ruby/object:Gem::Version
95
- version: '2.7'
93
+ version: '3.0'
96
94
  required_rubygems_version: !ruby/object:Gem::Requirement
97
95
  requirements:
98
96
  - - ">="
99
97
  - !ruby/object:Gem::Version
100
98
  version: '0'
101
99
  requirements: []
102
- rubygems_version: 3.5.6
103
- signing_key:
100
+ rubygems_version: 3.6.2
104
101
  specification_version: 4
105
102
  summary: API Client library for the AI Platform Notebooks API
106
103
  test_files: []