google-cloud-run-client 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5644274d40da43b05b91eaac3055ae9339628a5092f0b6de4812de31c4c633fd
-  data.tar.gz: 9736074a4db0bce96daf58f322c6c2de5db10641e9c002e6f2aaf6c6689d4123
+  metadata.gz: 83ec48aa543fedbde16fe74a8448d07953af89eb4797dc06e4ab398825ee7aad
+  data.tar.gz: b3280abe889dcafdd7f6a0582979f8701bd1bc16c1cd806efba2d32b1e5c2ecd
 SHA512:
-  metadata.gz: c97f7d98e7ecd956e8c97790644a4fc10a870d91c26bfd562fc4e1675d9735eec0bae35f365dff52069e205e113e14e42619c7e81af1690659c81da87dd81424
-  data.tar.gz: 3252e2a901131f680a4ef7c1c40b4ca1338fd62ef1dc87419f746c0ab985dc0300a624f5acfff17cc01fcc8a88bb2b9299bd879eea437fbd6f5bbc6445853c4f
+  metadata.gz: 84a2f8d4ed72ac9019b002b42007454779c9584f1a78a722f4997d99f6fab4bdb53e041c5e658c046376875bf72e67a373a6b99626044189b958e74146164176
+  data.tar.gz: f1795b28827c67601c1887c0155e2075a00035c0c740822d71a6afd8903c8abdc1f0f95ccbb1e5a2c858178f89138c5d5b2d2c5dea2d2bf9612d1ce56e4f8c81

data/AUTHENTICATION.md

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

data/README.md

@@ -34,9 +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/run.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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-run-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-run-v2/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/run/client/version.rb

@@ -18,7 +18,7 @@ module Google
   module Cloud
     module Run
       module Client
-        VERSION = "1.2.1"
+        VERSION = "1.4.0"
       end
     end
   end

data/lib/google/cloud/run.rb

@@ -45,6 +45,76 @@ end
 module Google
   module Cloud
     module Run
+      ##
+      # Create a new client object for Builds.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Run::V2::Builds::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-run-v2/latest/Google-Cloud-Run-V2-Builds-Client)
+      # for a gRPC client for version V2 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the Builds 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 Builds service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.builds_available?}.
+      #
+      # ## About Builds
+      #
+      # Cloud Run Build Control Plane API
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.builds version: :v2, transport: :grpc, &block
+        require "google/cloud/run/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Run.const_get(package_name).const_get(:Builds)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the Builds service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.builds}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Builds service,
+      # or if the versioned client gem needs an update to support the Builds service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.builds_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Builds
+        service_module = service_module.const_get :Builds
+        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 Executions.
       #
@@ -58,6 +128,11 @@ module Google
       # 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 Executions service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.executions_available?}.
+      #
       # ## About Executions
       #
       # Cloud Run Execution Control Plane API.
@@ -79,6 +154,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Executions service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.executions}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Executions service,
+      # or if the versioned client gem needs an update to support the Executions service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.executions_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Executions
+        service_module = service_module.const_get :Executions
+        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 Jobs.
       #
@@ -92,6 +198,11 @@ module Google
       # 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 Jobs service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.jobs_available?}.
+      #
       # ## About Jobs
       #
       # Cloud Run Job Control Plane API.
@@ -113,6 +224,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Jobs service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.jobs}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Jobs service,
+      # or if the versioned client gem needs an update to support the Jobs service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.jobs_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Jobs
+        service_module = service_module.const_get :Jobs
+        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 Revisions.
       #
@@ -126,6 +268,11 @@ module Google
       # 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 Revisions service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.revisions_available?}.
+      #
       # ## About Revisions
       #
       # Cloud Run Revision Control Plane API.
@@ -147,6 +294,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Revisions service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.revisions}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Revisions service,
+      # or if the versioned client gem needs an update to support the Revisions service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.revisions_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Revisions
+        service_module = service_module.const_get :Revisions
+        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 Services.
       #
@@ -160,6 +338,11 @@ module Google
       # 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 Services service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.services_available?}.
+      #
       # ## About Services
       #
       # Cloud Run Service Control Plane API
@@ -181,6 +364,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Services service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.services}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Services service,
+      # or if the versioned client gem needs an update to support the Services service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.services_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Services
+        service_module = service_module.const_get :Services
+        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 Tasks.
       #
@@ -194,6 +408,11 @@ module Google
       # 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 Tasks service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Run.tasks_available?}.
+      #
       # ## About Tasks
       #
       # Cloud Run Task Control Plane API.
@@ -215,6 +434,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Tasks service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Run.tasks}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Tasks service,
+      # or if the versioned client gem needs an update to support the Tasks service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.tasks_available? version: :v2, transport: :grpc
+        require "google/cloud/run/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Run
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Run.const_get package_name
+        return false unless service_module.const_defined? :Tasks
+        service_module = service_module.const_get :Tasks
+        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
+
       ##
       # Configure the google-cloud-run-client library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-run-client
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -30,7 +29,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.17'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -40,7 +39,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.17'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,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 Cloud Run API
 test_files: []