google-cloud-workflows 2.5.1 → 2.6.0

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: c5ed7d86804a38784cca2f5df4a2c05ee9467e52e3562fadb70d4dc9bf80cfaa
4
- data.tar.gz: 94d94ff0d4441ec676e2b89a726d69e228f4b0d885b7473eb97e770f8ea9e997
3
+ metadata.gz: 61dc5b2fee82c42abe2ac7d75731378569b1fdb5e9c5eb067356fa39807eb407
4
+ data.tar.gz: 0d807b8e7017c83c6d7998d61a8eb055b7f0988a583fb3e3ebab3d5f60e2d55d
5
5
  SHA512:
6
- metadata.gz: '09164d2536964067072307417d8df9ab92ca97116e93bf097bc895611924950c68b3b8010b2ff6d62f52c8f824d283b467862511a18473710565f5d7b82cb9bf'
7
- data.tar.gz: 9d1824a848283c9774cc760882ff635ef8d893b3c7e4288f4a00071660ac9caded55816e31ed62a70d00395837c165bac0e754777000aac7fe24922ec3263a17
6
+ metadata.gz: 18e1839a8b102e636942ead2485d9d51cc1aed038a860a1588a2e7fa7df684376ab7089bfbfcfb0f678fefdd00f68c1447952ce882471e66781156d9c0384a49
7
+ data.tar.gz: d398c10f84e28b80ff9fbcfaf74dbd30628e9f1217605210e7604d419e25b849a7280861bcd0a0980c58fbe2af80963a0ccc58c69aa60e9c35f5df0ee0de3bd3
data/README.md CHANGED
@@ -19,6 +19,8 @@ client gems:
19
19
  [google-cloud-workflows-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest),
20
20
  [google-cloud-workflows-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1beta/latest),
21
21
  [google-cloud-workflows-executions-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1/latest),
22
+ [google-cloud-workflows-executions-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1beta/latest),
23
+ [google-cloud-workflows-executions-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1/latest),
22
24
  [google-cloud-workflows-executions-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-executions-v1beta/latest).
23
25
 
24
26
  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:
37
39
  1. [Enable the API.](https://console.cloud.google.com/apis/library/workflows.googleapis.com)
38
40
  1. {file:AUTHENTICATION.md Set up authentication.}
39
41
 
42
+ ## Debug Logging
43
+
44
+ This library comes with opt-in Debug Logging that can help you troubleshoot
45
+ your application's integration with the API. When logging is activated, key
46
+ events such as requests and responses, along with data payloads and metadata
47
+ such as headers and client configuration, are logged to the standard error
48
+ stream.
49
+
50
+ **WARNING:** Client Library Debug Logging includes your data payloads in
51
+ plaintext, which could include sensitive data such as PII for yourself or your
52
+ customers, private keys, or other security data that could be compromising if
53
+ leaked. Always practice good data hygiene with your application logs, and follow
54
+ the principle of least access. Google also recommends that Client Library Debug
55
+ Logging be enabled only temporarily during active debugging, and not used
56
+ permanently in production.
57
+
58
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
59
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
60
+ list of client library gem names. This will select the default logging behavior,
61
+ which writes logs to the standard error stream. On a local workstation, this may
62
+ result in logs appearing on the console. When running on a Google Cloud hosting
63
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
64
+ results in logs appearing alongside your application logs in the
65
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
66
+
67
+ Debug logging also requires that the versioned clients for this service be
68
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
69
+ working, try updating the versioned clients in your bundle or installed gems:
70
+ [google-cloud-workflows-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest),
71
+ [google-cloud-workflows-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1beta/latest).
72
+
40
73
  ## Supported Ruby Versions
41
74
 
42
- This library is supported on Ruby 2.7+.
75
+ This library is supported on Ruby 3.0+.
43
76
 
44
77
  Google provides official support for Ruby versions that are actively supported
45
78
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -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 Executions service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::Workflows::Executions.executions_available?}.
64
+ #
60
65
  # ## About Executions
61
66
  #
62
67
  # Executions is used to start and manage running instances of
@@ -77,6 +82,32 @@ module Google
77
82
  service_module.const_get(:Client).new(&block)
78
83
  end
79
84
 
85
+ ##
86
+ # Determines whether the Executions service is supported by the current client.
87
+ # If true, you can retrieve a client object by calling {Google::Cloud::Workflows::Executions.executions}.
88
+ # If false, that method will raise an exception. This could happen if the given
89
+ # API version does not exist or does not support the Executions service,
90
+ # or if the versioned client gem needs an update to support the Executions service.
91
+ #
92
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
93
+ # Defaults to `:v1`.
94
+ # @return [boolean] Whether the service is available.
95
+ #
96
+ def self.executions_available? version: :v1
97
+ require "google/cloud/workflows/executions/#{version.to_s.downcase}"
98
+ package_name = Google::Cloud::Workflows::Executions
99
+ .constants
100
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
101
+ .first
102
+ return false unless package_name
103
+ service_module = Google::Cloud::Workflows::Executions.const_get package_name
104
+ return false unless service_module.const_defined? :Executions
105
+ service_module = service_module.const_get :Executions
106
+ service_module.const_defined? :Client
107
+ rescue ::LoadError
108
+ false
109
+ end
110
+
80
111
  ##
81
112
  # Configure the google-cloud-workflows-executions library.
82
113
  #
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Workflows
23
- VERSION = "2.5.1"
23
+ VERSION = "2.6.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 Workflows service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Workflows.workflows_available?}.
65
+ #
61
66
  # ## About Workflows
62
67
  #
63
68
  # Workflows is used to deploy and execute workflow programs.
@@ -81,6 +86,37 @@ module Google
81
86
  service_module.const_get(:Client).new(&block)
82
87
  end
83
88
 
89
+ ##
90
+ # Determines whether the Workflows service is supported by the current client.
91
+ # If true, you can retrieve a client object by calling {Google::Cloud::Workflows.workflows}.
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 Workflows service,
94
+ # or if the versioned client gem needs an update to support the Workflows service.
95
+ #
96
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
97
+ # Defaults to `:v1`.
98
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
99
+ # @return [boolean] Whether the service is available.
100
+ #
101
+ def self.workflows_available? version: :v1, transport: :grpc
102
+ require "google/cloud/workflows/#{version.to_s.downcase}"
103
+ package_name = Google::Cloud::Workflows
104
+ .constants
105
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
106
+ .first
107
+ return false unless package_name
108
+ service_module = Google::Cloud::Workflows.const_get package_name
109
+ return false unless service_module.const_defined? :Workflows
110
+ service_module = service_module.const_get :Workflows
111
+ if transport == :rest
112
+ return false unless service_module.const_defined? :Rest
113
+ service_module = service_module.const_get :Rest
114
+ end
115
+ service_module.const_defined? :Client
116
+ rescue ::LoadError
117
+ false
118
+ end
119
+
84
120
  ##
85
121
  # Configure the google-cloud-workflows library.
86
122
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-workflows
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.5.1
4
+ version: 2.6.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-06-12 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
@@ -127,7 +126,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
127
126
  licenses:
128
127
  - Apache-2.0
129
128
  metadata: {}
130
- post_install_message:
131
129
  rdoc_options: []
132
130
  require_paths:
133
131
  - lib
@@ -135,15 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
135
133
  requirements:
136
134
  - - ">="
137
135
  - !ruby/object:Gem::Version
138
- version: '2.7'
136
+ version: '3.0'
139
137
  required_rubygems_version: !ruby/object:Gem::Requirement
140
138
  requirements:
141
139
  - - ">="
142
140
  - !ruby/object:Gem::Version
143
141
  version: '0'
144
142
  requirements: []
145
- rubygems_version: 3.5.6
146
- signing_key:
143
+ rubygems_version: 3.6.2
147
144
  specification_version: 4
148
145
  summary: API Client library for the Workflows API
149
146
  test_files: []