google-cloud-orchestration-airflow-service 1.4.0 → 1.5.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: db790d5223bfd20ee4afd70163cdf3726c7cfe09ff4a73157f169de400349b31
4
- data.tar.gz: 7a76f0469743fbd7d5e13767870ee98d86b30f4ec02ca9fe2b049cddc5c428b4
3
+ metadata.gz: 751b502700da490d4c703288a7cf482b9740fc15326ab7390e28141a3165add6
4
+ data.tar.gz: b25ad35f8351604fdbf200e90cd29cda435d3e4d954fe41e42ee3dfe1b474e47
5
5
  SHA512:
6
- metadata.gz: ab9a6d4b701843f54e558911434b63ecc93663f8e0201016770d3973819366bcf7e229c695dadb4717f092f75f6a5be628a32a552a1fa8540782a0c157a246ab
7
- data.tar.gz: 65daececd405f6d297ab23c51ef19ddfd01a19d48a1a8073a7746caca29af952ad7e22b43c9746710823e33ed21bd653134e2df4ee28cb0ff39e004ecf678faf
6
+ metadata.gz: 917cdfd2aba0b7c202c62bd552ac5d658e2b2da496042c5e6c111983d85973dd440bd2fa2d2cea8e589d27c1ee820dec4c164b3415572c83001237114d97a5d9
7
+ data.tar.gz: edff29b7c8f7b30cbf394f4dd2a2a534f13a7c070a9fb0347e0f1fbe0e0716e6f05b78d772f551e96a0fc9ca4f37441651f6c6346497b8141f144e1a2e8ff1c9
data/README.md CHANGED
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/composer.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-orchestration-airflow-service-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest).
66
+
37
67
  ## Supported Ruby Versions
38
68
 
39
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
40
70
 
41
71
  Google provides official support for Ruby versions that are actively supported
42
72
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -22,7 +22,7 @@ module Google
22
22
  module Orchestration
23
23
  module Airflow
24
24
  module Service
25
- VERSION = "1.4.0"
25
+ VERSION = "1.5.0"
26
26
  end
27
27
  end
28
28
  end
@@ -60,6 +60,11 @@ module Google
60
60
  # You can also specify a different transport by passing `:rest` or `:grpc` in
61
61
  # the `transport` parameter.
62
62
  #
63
+ # Raises an exception if the currently installed versioned client gem for the
64
+ # given API version does not support the given transport of the Environments service.
65
+ # You can determine whether the method will succeed by calling
66
+ # {Google::Cloud::Orchestration::Airflow::Service.environments_available?}.
67
+ #
63
68
  # ## About Environments
64
69
  #
65
70
  # Managed Apache Airflow Environments.
@@ -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 Environments service is supported by the current client.
91
+ # If true, you can retrieve a client object by calling {Google::Cloud::Orchestration::Airflow::Service.environments}.
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 Environments service,
94
+ # or if the versioned client gem needs an update to support the Environments 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.environments_available? version: :v1, transport: :grpc
102
+ require "google/cloud/orchestration/airflow/service/#{version.to_s.downcase}"
103
+ package_name = Google::Cloud::Orchestration::Airflow::Service
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::Orchestration::Airflow::Service.const_get package_name
109
+ return false unless service_module.const_defined? :Environments
110
+ service_module = service_module.const_get :Environments
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
  # Create a new client object for ImageVersions.
86
122
  #
@@ -94,6 +130,11 @@ module Google
94
130
  # You can also specify a different transport by passing `:rest` or `:grpc` in
95
131
  # the `transport` parameter.
96
132
  #
133
+ # Raises an exception if the currently installed versioned client gem for the
134
+ # given API version does not support the given transport of the ImageVersions service.
135
+ # You can determine whether the method will succeed by calling
136
+ # {Google::Cloud::Orchestration::Airflow::Service.image_versions_available?}.
137
+ #
97
138
  # ## About ImageVersions
98
139
  #
99
140
  # Readonly service to query available ImageVersions.
@@ -115,6 +156,37 @@ module Google
115
156
  service_module.const_get(:Client).new(&block)
116
157
  end
117
158
 
159
+ ##
160
+ # Determines whether the ImageVersions service is supported by the current client.
161
+ # If true, you can retrieve a client object by calling {Google::Cloud::Orchestration::Airflow::Service.image_versions}.
162
+ # If false, that method will raise an exception. This could happen if the given
163
+ # API version does not exist or does not support the ImageVersions service,
164
+ # or if the versioned client gem needs an update to support the ImageVersions service.
165
+ #
166
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
167
+ # Defaults to `:v1`.
168
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
169
+ # @return [boolean] Whether the service is available.
170
+ #
171
+ def self.image_versions_available? version: :v1, transport: :grpc
172
+ require "google/cloud/orchestration/airflow/service/#{version.to_s.downcase}"
173
+ package_name = Google::Cloud::Orchestration::Airflow::Service
174
+ .constants
175
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
176
+ .first
177
+ return false unless package_name
178
+ service_module = Google::Cloud::Orchestration::Airflow::Service.const_get package_name
179
+ return false unless service_module.const_defined? :ImageVersions
180
+ service_module = service_module.const_get :ImageVersions
181
+ if transport == :rest
182
+ return false unless service_module.const_defined? :Rest
183
+ service_module = service_module.const_get :Rest
184
+ end
185
+ service_module.const_defined? :Client
186
+ rescue ::LoadError
187
+ false
188
+ end
189
+
118
190
  ##
119
191
  # Configure the google-cloud-orchestration-airflow-service library.
120
192
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-orchestration-airflow-service
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.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-02-26 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
@@ -64,7 +63,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
64
63
  licenses:
65
64
  - Apache-2.0
66
65
  metadata: {}
67
- post_install_message:
68
66
  rdoc_options: []
69
67
  require_paths:
70
68
  - lib
@@ -72,15 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
72
70
  requirements:
73
71
  - - ">="
74
72
  - !ruby/object:Gem::Version
75
- version: '2.7'
73
+ version: '3.0'
76
74
  required_rubygems_version: !ruby/object:Gem::Requirement
77
75
  requirements:
78
76
  - - ">="
79
77
  - !ruby/object:Gem::Version
80
78
  version: '0'
81
79
  requirements: []
82
- rubygems_version: 3.5.6
83
- signing_key:
80
+ rubygems_version: 3.6.2
84
81
  specification_version: 4
85
82
  summary: API Client library for the Cloud Composer API
86
83
  test_files: []