google-cloud-apigee_registry 1.2.0 → 1.3.1

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: 8c9acbfc194414d30a13553d8e75060e681127950eaf224451a45f2f1f02ab43
4
- data.tar.gz: 191b3c31ad3e6cf522029ac5eaa6b3c78b5df8cfc958ed904f0a09fe2935b493
3
+ metadata.gz: f39ebabb0fe48eebf087e5bd6f816b5c75dcecf40e920d9899fd9195fce51163
4
+ data.tar.gz: dc8a04d047670a9374033fbe1aaebc99dd59485d5dd7f7301c58d42ebebaaa92
5
5
  SHA512:
6
- metadata.gz: 4a91caac2bc1e4eee9d3c165ef807b1efae323e24036072e5fb00825def854c2ae95f3ea3ef1cc8e74978652c51db1e97540f312e1f9d1e1176721cadd2c7206
7
- data.tar.gz: 799411de7c31a362bf506c3910176a61dfa682f616f50b6006d552bb41423433adf1cf8c34545c143d13d2bf65330fda12166154e5356227177cd61e63ad89af
6
+ metadata.gz: 77cec4f37f5e5afe67a114dc6265997120a9e93c9a8832831af397943170fbe343759e1f3e47d3382e5af898fabac32553a76da43ef0192d467332c49144d4c7
7
+ data.tar.gz: a0b331c6dedeacb93346f7b2cf877d7f3c50357f593bd4b7905ea1a65fe3b7a83ed9e12e7fc9f1c372a44b49b5e55519728e17cd4150c24968e5273dc1b5e29e
data/README.md CHANGED
@@ -7,7 +7,7 @@ The Apigee Registry API allows teams to upload and share machine-readable descri
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-apigee_registry-v*`.
9
9
  The gem `google-cloud-apigee_registry` is the main client library that brings the
10
- verisoned gems in as dependencies, and provides high-level methods for
10
+ versioned gems in as dependencies, and provides high-level methods for
11
11
  constructing clients. More information on versioned clients can be found below
12
12
  in the section titled *Which client should I use?*.
13
13
 
@@ -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/apigeeregistry.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-apigee_registry-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-apigee_registry-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
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module ApigeeRegistry
23
- VERSION = "1.2.0"
23
+ VERSION = "1.3.1"
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 Provisioning service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::ApigeeRegistry.provisioning_available?}.
65
+ #
61
66
  # ## About Provisioning
62
67
  #
63
68
  # The service that is used for managing the data plane provisioning of the
@@ -80,6 +85,37 @@ module Google
80
85
  service_module.const_get(:Client).new(&block)
81
86
  end
82
87
 
88
+ ##
89
+ # Determines whether the Provisioning service is supported by the current client.
90
+ # If true, you can retrieve a client object by calling {Google::Cloud::ApigeeRegistry.provisioning}.
91
+ # If false, that method will raise an exception. This could happen if the given
92
+ # API version does not exist or does not support the Provisioning service,
93
+ # or if the versioned client gem needs an update to support the Provisioning service.
94
+ #
95
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
96
+ # Defaults to `:v1`.
97
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
98
+ # @return [boolean] Whether the service is available.
99
+ #
100
+ def self.provisioning_available? version: :v1, transport: :grpc
101
+ require "google/cloud/apigee_registry/#{version.to_s.downcase}"
102
+ package_name = Google::Cloud::ApigeeRegistry
103
+ .constants
104
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
105
+ .first
106
+ return false unless package_name
107
+ service_module = Google::Cloud::ApigeeRegistry.const_get package_name
108
+ return false unless service_module.const_defined? :Provisioning
109
+ service_module = service_module.const_get :Provisioning
110
+ if transport == :rest
111
+ return false unless service_module.const_defined? :Rest
112
+ service_module = service_module.const_get :Rest
113
+ end
114
+ service_module.const_defined? :Client
115
+ rescue ::LoadError
116
+ false
117
+ end
118
+
83
119
  ##
84
120
  # Create a new client object for Registry.
85
121
  #
@@ -93,6 +129,11 @@ module Google
93
129
  # You can also specify a different transport by passing `:rest` or `:grpc` in
94
130
  # the `transport` parameter.
95
131
  #
132
+ # Raises an exception if the currently installed versioned client gem for the
133
+ # given API version does not support the given transport of the Registry service.
134
+ # You can determine whether the method will succeed by calling
135
+ # {Google::Cloud::ApigeeRegistry.registry_available?}.
136
+ #
96
137
  # ## About Registry
97
138
  #
98
139
  # The Registry service allows teams to manage descriptions of APIs.
@@ -114,6 +155,37 @@ module Google
114
155
  service_module.const_get(:Client).new(&block)
115
156
  end
116
157
 
158
+ ##
159
+ # Determines whether the Registry service is supported by the current client.
160
+ # If true, you can retrieve a client object by calling {Google::Cloud::ApigeeRegistry.registry}.
161
+ # If false, that method will raise an exception. This could happen if the given
162
+ # API version does not exist or does not support the Registry service,
163
+ # or if the versioned client gem needs an update to support the Registry service.
164
+ #
165
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
166
+ # Defaults to `:v1`.
167
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
168
+ # @return [boolean] Whether the service is available.
169
+ #
170
+ def self.registry_available? version: :v1, transport: :grpc
171
+ require "google/cloud/apigee_registry/#{version.to_s.downcase}"
172
+ package_name = Google::Cloud::ApigeeRegistry
173
+ .constants
174
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
175
+ .first
176
+ return false unless package_name
177
+ service_module = Google::Cloud::ApigeeRegistry.const_get package_name
178
+ return false unless service_module.const_defined? :Registry
179
+ service_module = service_module.const_get :Registry
180
+ if transport == :rest
181
+ return false unless service_module.const_defined? :Rest
182
+ service_module = service_module.const_get :Rest
183
+ end
184
+ service_module.const_defined? :Client
185
+ rescue ::LoadError
186
+ false
187
+ end
188
+
117
189
  ##
118
190
  # Configure the google-cloud-apigee_registry library.
119
191
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-apigee_registry
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.3.1
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: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-apigee_registry-v1
@@ -68,7 +67,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
68
67
  licenses:
69
68
  - Apache-2.0
70
69
  metadata: {}
71
- post_install_message:
72
70
  rdoc_options: []
73
71
  require_paths:
74
72
  - lib
@@ -76,15 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
76
74
  requirements:
77
75
  - - ">="
78
76
  - !ruby/object:Gem::Version
79
- version: '2.7'
77
+ version: '3.0'
80
78
  required_rubygems_version: !ruby/object:Gem::Requirement
81
79
  requirements:
82
80
  - - ">="
83
81
  - !ruby/object:Gem::Version
84
82
  version: '0'
85
83
  requirements: []
86
- rubygems_version: 3.5.6
87
- signing_key:
84
+ rubygems_version: 3.6.8
88
85
  specification_version: 4
89
86
  summary: API Client library for the Apigee Registry API
90
87
  test_files: []