google-cloud-apigee_connect 1.4.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 714871cebe29a6194d34aa961105785ad3c5483f934820a31f11c9ca7fe6269a
4
- data.tar.gz: d582105391c4194aee9d19969ee2d8a9b82da29453ba78d7c1715a0a4c1b1c09
3
+ metadata.gz: 6a6b77732c5635513c5ee2a8383770d1962f41049193d7412654b8a6acf14365
4
+ data.tar.gz: dfe0d390853ef318bfbe9a04e5d2e5636cad377823d0960cca0e2668260c7dca
5
5
  SHA512:
6
- metadata.gz: 6aab0b01c8a71f5314677a05fe51f3402259a972c7a5d7991c1bc502a764641478b417f822d182e5f71b5f65755ef0d5419c0de9ea34d8a96aa708df9f68ea06
7
- data.tar.gz: 544d2a78e62174ea076b12f4529cacb3dc264ff3f812ac25ff23d869233cbf150cd92fe1b63449c65d9cf192c11c4a50760d73845fbb703903863b90c636c5cf
6
+ metadata.gz: d51bd7eca23e93cfd4fc7c649223c5544cdf96297dc1078b019361cce3c8e67a0040dbb95006f680ebeabb344d41cb5562250a04e1febefb4dd2e03f6ffeefa0
7
+ data.tar.gz: 7dcd9306b69e678d4dc11682f8c3df8f12af869aed025fefc741b326be0a8eb9f794b4871d56cc22740b741d8790fd93d4355e5ee474d9d074c455d7c6201ee4
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/apigeeconnect.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_connect-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-apigee_connect-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 ApigeeConnect
23
- VERSION = "1.4.0"
23
+ VERSION = "1.5.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 ConnectionService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::ApigeeConnect.connection_service_available?}.
65
+ #
61
66
  # ## About ConnectionService
62
67
  #
63
68
  # Service Interface for the Apigee Connect connection management APIs.
@@ -79,6 +84,37 @@ module Google
79
84
  service_module.const_get(:Client).new(&block)
80
85
  end
81
86
 
87
+ ##
88
+ # Determines whether the ConnectionService service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::ApigeeConnect.connection_service}.
90
+ # If false, that method will raise an exception. This could happen if the given
91
+ # API version does not exist or does not support the ConnectionService service,
92
+ # or if the versioned client gem needs an update to support the ConnectionService service.
93
+ #
94
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
95
+ # Defaults to `:v1`.
96
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
97
+ # @return [boolean] Whether the service is available.
98
+ #
99
+ def self.connection_service_available? version: :v1, transport: :grpc
100
+ require "google/cloud/apigee_connect/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::ApigeeConnect
102
+ .constants
103
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
104
+ .first
105
+ return false unless package_name
106
+ service_module = Google::Cloud::ApigeeConnect.const_get package_name
107
+ return false unless service_module.const_defined? :ConnectionService
108
+ service_module = service_module.const_get :ConnectionService
109
+ if transport == :rest
110
+ return false unless service_module.const_defined? :Rest
111
+ service_module = service_module.const_get :Rest
112
+ end
113
+ service_module.const_defined? :Client
114
+ rescue ::LoadError
115
+ false
116
+ end
117
+
82
118
  ##
83
119
  # Create a new client object for Tether.
84
120
  #
@@ -90,6 +126,11 @@ module Google
90
126
  # supported by that API version, and the corresponding gem is available, the
91
127
  # appropriate versioned client will be returned.
92
128
  #
129
+ # Raises an exception if the currently installed versioned client gem for the
130
+ # given API version does not support the Tether service.
131
+ # You can determine whether the method will succeed by calling
132
+ # {Google::Cloud::ApigeeConnect.tether_available?}.
133
+ #
93
134
  # ## About Tether
94
135
  #
95
136
  # Tether provides a way for the control plane to send HTTP API requests to
@@ -111,6 +152,32 @@ module Google
111
152
  service_module.const_get(:Client).new(&block)
112
153
  end
113
154
 
155
+ ##
156
+ # Determines whether the Tether service is supported by the current client.
157
+ # If true, you can retrieve a client object by calling {Google::Cloud::ApigeeConnect.tether}.
158
+ # If false, that method will raise an exception. This could happen if the given
159
+ # API version does not exist or does not support the Tether service,
160
+ # or if the versioned client gem needs an update to support the Tether service.
161
+ #
162
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
163
+ # Defaults to `:v1`.
164
+ # @return [boolean] Whether the service is available.
165
+ #
166
+ def self.tether_available? version: :v1
167
+ require "google/cloud/apigee_connect/#{version.to_s.downcase}"
168
+ package_name = Google::Cloud::ApigeeConnect
169
+ .constants
170
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
171
+ .first
172
+ return false unless package_name
173
+ service_module = Google::Cloud::ApigeeConnect.const_get package_name
174
+ return false unless service_module.const_defined? :Tether
175
+ service_module = service_module.const_get :Tether
176
+ service_module.const_defined? :Client
177
+ rescue ::LoadError
178
+ false
179
+ end
180
+
114
181
  ##
115
182
  # Configure the google-cloud-apigee_connect library.
116
183
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-apigee_connect
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-apigee_connect-v1
@@ -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 Apigee Connect API
86
83
  test_files: []