google-cloud-notebooks 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bfe4ab5a9d3521b1ef78fff7ae6dfae9dd043e514b0b67e5bec4002e3ca3292
-  data.tar.gz: fcf6e79d32e60b2b94b0fe66a85937b37faf532802f2ce27a6b85eba1963b7ee
+  metadata.gz: 12fa26b9b17a95c70ad93b1957924e4bca151639e42fbc0ea0da2714f0004aaf
+  data.tar.gz: 18f26f24817f69b355b44667f397ef80ba94040e316f27a3a5dfd269b8b3c6e8
 SHA512:
-  metadata.gz: c6499999ee0ec642da9c1675d7feac6294be24dc01be6b616cf0c35b8430910077ac14a1c683917fa868e85010c2138bdaa59c12e1551b40234232a819e025ba
-  data.tar.gz: f5a676dcc644d21037828f73b5e4a292516e77ef5d3561b8f1cdbb563288213ac23a51337b4897d4281fed8f0c568761e6fb5c6c1f8627ce710208caceec3805
+  metadata.gz: 8a3f76cf5d2d843a1072c193b6695ffcdcc67e57d67906e019899c2527339037d2cebcf6c4bbc9c6dfc59e65c23ffb2e65141e298351f010c665a0a0216b51be
+  data.tar.gz: 99a1bba2f72854ec0cbcb2d22d1d88487dcece13defeda86dd88e6b1c902c118128a6e01a2496787b1c4829fb3dd306982537c1e3e37380ec049fd75e58498a9

data/AUTHENTICATION.md

@@ -56,7 +56,7 @@ To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/notebooks"
 
-client = Google::Cloud::Notebooks.notebook_service do |config|
+client = Google::Cloud::Notebooks.managed_notebook_service do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -70,7 +70,7 @@ Google::Cloud::Notebooks.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = Google::Cloud::Notebooks.notebook_service
+client = Google::Cloud::Notebooks.managed_notebook_service
 ```
 
 ### Environment Variables
@@ -100,7 +100,7 @@ require "google/cloud/notebooks"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = Google::Cloud::Notebooks.notebook_service
+client = Google::Cloud::Notebooks.managed_notebook_service
 ```
 
 ### Local ADC file

data/README.md

@@ -17,7 +17,7 @@ constructing client objects. Reference documentation for the client objects
 themselves can be found in the client library documentation for the versioned
 client gems:
 [google-cloud-notebooks-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1/latest),
-[google-cloud-notebooks-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1beta1/latest).
+[google-cloud-notebooks-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest).
 
 See also the [Product Documentation](https://cloud.google.com/ai-platform-notebooks)
 for more usage information.
@@ -64,7 +64,7 @@ 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-notebooks-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1/latest),
-[google-cloud-notebooks-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1beta1/latest).
+[google-cloud-notebooks-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest).
 
 ## Supported Ruby Versions
 

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Notebooks
-      VERSION = "2.5.0"
+      VERSION = "3.0.0"
     end
   end
 end

data/lib/google/cloud/notebooks.rb

@@ -45,6 +45,76 @@ end
 module Google
   module Cloud
     module Notebooks
+      ##
+      # Create a new client object for ManagedNotebookService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Notebooks::V1::ManagedNotebookService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1/latest/Google-Cloud-Notebooks-V1-ManagedNotebookService-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the ManagedNotebookService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ManagedNotebookService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Notebooks.managed_notebook_service_available?}.
+      #
+      # ## About ManagedNotebookService
+      #
+      # API v1 service for Managed Notebooks.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.managed_notebook_service version: :v1, transport: :grpc, &block
+        require "google/cloud/notebooks/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Notebooks
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Notebooks.const_get(package_name).const_get(:ManagedNotebookService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the ManagedNotebookService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Notebooks.managed_notebook_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ManagedNotebookService service,
+      # or if the versioned client gem needs an update to support the ManagedNotebookService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.managed_notebook_service_available? version: :v1, transport: :grpc
+        require "google/cloud/notebooks/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Notebooks
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Notebooks.const_get package_name
+        return false unless service_module.const_defined? :ManagedNotebookService
+        service_module = service_module.const_get :ManagedNotebookService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for NotebookService.
       #
@@ -65,7 +135,7 @@ module Google
       #
       # ## About NotebookService
       #
-      # API v1beta1 service for Cloud AI Platform Notebooks.
+      # API v1 service for Cloud AI Platform Notebooks.
       #
       # @param version [::String, ::Symbol] The API version to connect to. Optional.
       #   Defaults to `:v1`.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-notebooks
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -27,42 +27,30 @@ dependencies:
   name: google-cloud-notebooks-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: google-cloud-notebooks-v1beta1
+  name: google-cloud-notebooks-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
 description: AI Platform Notebooks makes it easy to manage JupyterLab instances through
   a protected, publicly available notebook instance URL. A JupyterLab instance is
   a Deep Learning virtual machine instance with the latest machine learning and data
@@ -97,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for the AI Platform Notebooks API
 test_files: []