google-cloud-workflows 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38763d04f926bc600644be2630c21d8ccbab132614aacebe896a7f9edc0f0141
-  data.tar.gz: 247afb36c603072d23ed01abb174270184bef3a52dd2ace8417d2a39b8659c01
+  metadata.gz: 61dc5b2fee82c42abe2ac7d75731378569b1fdb5e9c5eb067356fa39807eb407
+  data.tar.gz: 0d807b8e7017c83c6d7998d61a8eb055b7f0988a583fb3e3ebab3d5f60e2d55d
 SHA512:
-  metadata.gz: 64113acaed1c05a70dedf37ab48aa5764151122bccff655b6a32ef3baa44c113ad816434ba0596546684ac2633a68d4994d19f10cde4afd46680b911b4104355
-  data.tar.gz: 9b773b7c9eb5c0b7f1bc072ecfbbf87ef6f815d2e50e7bdbfad46c8630dc456297aac51d6afbf211243a3c0973bc747f7d75e306692f7c4ed92f7fb7ed6eab29
+  metadata.gz: 18e1839a8b102e636942ead2485d9d51cc1aed038a860a1588a2e7fa7df684376ab7089bfbfcfb0f678fefdd00f68c1447952ce882471e66781156d9c0384a49
+  data.tar.gz: d398c10f84e28b80ff9fbcfaf74dbd30628e9f1217605210e7604d419e25b849a7280861bcd0a0980c58fbe2af80963a0ccc58c69aa60e9c35f5df0ee0de3bd3

data/README.md

@@ -19,6 +19,8 @@ client gems:
 [google-cloud-workflows-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest),
 [google-cloud-workflows-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1beta/latest),
 [google-cloud-workflows-executions-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1/latest),
+[google-cloud-workflows-executions-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1beta/latest),
+[google-cloud-workflows-executions-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1/latest),
 [google-cloud-workflows-executions-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1beta/latest).
 
 See also the [Product Documentation](https://cloud.google.com/workflows/)
@@ -37,9 +39,40 @@ 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/workflows.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-workflows-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest),
+[google-cloud-workflows-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1beta/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/workflows/executions.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 Executions service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Workflows::Executions.executions_available?}.
+        #
         # ## About Executions
         #
         # Executions is used to start and manage running instances of
@@ -77,6 +82,32 @@ 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::Workflows::Executions.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 `:v1`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.executions_available? version: :v1
+          require "google/cloud/workflows/executions/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Workflows::Executions
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Workflows::Executions.const_get package_name
+          return false unless service_module.const_defined? :Executions
+          service_module = service_module.const_get :Executions
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Configure the google-cloud-workflows-executions library.
         #

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Workflows
-      VERSION = "2.5.2"
+      VERSION = "2.6.0"
     end
   end
 end

data/lib/google/cloud/workflows.rb

@@ -58,6 +58,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 Workflows service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Workflows.workflows_available?}.
+      #
       # ## About Workflows
       #
       # Workflows is used to deploy and execute workflow programs.
@@ -81,6 +86,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Workflows service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Workflows.workflows}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Workflows service,
+      # or if the versioned client gem needs an update to support the Workflows 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.workflows_available? version: :v1, transport: :grpc
+        require "google/cloud/workflows/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Workflows
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Workflows.const_get package_name
+        return false unless service_module.const_defined? :Workflows
+        service_module = service_module.const_get :Workflows
+        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-workflows library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-workflows
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -127,7 +126,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -135,15 +133,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 Workflows API
 test_files: []