google-cloud-app_engine 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: 9d4560ae4525fb24c49795b1d689334dad32812977399815d5d94067b40d0142
4
- data.tar.gz: af29ff03625786ff63cc3b63575c3dfe4b933a0c30ecd4af22417e04a09f1fa0
3
+ metadata.gz: 5401c4e527af144f3bdee0e6900d300b189bca3ff53b8b297ea1d9533b2ec500
4
+ data.tar.gz: 6ddb283c3e99d77c3d7741f15618d3a878f2a67efca0b6878ac38718e71d0c11
5
5
  SHA512:
6
- metadata.gz: cee49eceb2df59c5f0a062544941a6b91376e0ceda107e27ded40da324a37b7a1c7972b4bf35c67b2eb175a438c3881edb8fd5a6dedc7349915506acadcf0c5a
7
- data.tar.gz: fd3fd0d776e1b1dad872efeea1e1a9aee9e5e69432c4e53b0cdb445b35c087314ac9379e44fb48d9cfd7dfca33d479768464ef386b63b1a3944fcd6a5aac134e
6
+ metadata.gz: 86f3a382f19f0b000fac122312686ddf605ebd8f9b512faec467382b0525f70d50af47a9fddbfea59d1831c7dbd827d29146347355df41473b5e7883cb703d33
7
+ data.tar.gz: 93952c80d2f74b9074de9a30fce2ea9cca80664db63fdd527df9e5282be3712f308460685123eaafa4874e01a69394d3591feefccdf690999b180f744abb8245
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/appengine.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-app_engine-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-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 AppEngine
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 Applications service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::AppEngine.applications_available?}.
65
+ #
61
66
  # ## About Applications
62
67
  #
63
68
  # Manages App Engine applications.
@@ -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 Applications service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.applications}.
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 Applications service,
92
+ # or if the versioned client gem needs an update to support the Applications 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.applications_available? version: :v1, transport: :grpc
100
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::AppEngine
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::AppEngine.const_get package_name
107
+ return false unless service_module.const_defined? :Applications
108
+ service_module = service_module.const_get :Applications
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 Services.
84
120
  #
@@ -92,6 +128,11 @@ module Google
92
128
  # You can also specify a different transport by passing `:rest` or `:grpc` in
93
129
  # the `transport` parameter.
94
130
  #
131
+ # Raises an exception if the currently installed versioned client gem for the
132
+ # given API version does not support the given transport of the Services service.
133
+ # You can determine whether the method will succeed by calling
134
+ # {Google::Cloud::AppEngine.services_available?}.
135
+ #
95
136
  # ## About Services
96
137
  #
97
138
  # Manages services of an application.
@@ -113,6 +154,37 @@ module Google
113
154
  service_module.const_get(:Client).new(&block)
114
155
  end
115
156
 
157
+ ##
158
+ # Determines whether the Services service is supported by the current client.
159
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.services}.
160
+ # If false, that method will raise an exception. This could happen if the given
161
+ # API version does not exist or does not support the Services service,
162
+ # or if the versioned client gem needs an update to support the Services service.
163
+ #
164
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
165
+ # Defaults to `:v1`.
166
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
167
+ # @return [boolean] Whether the service is available.
168
+ #
169
+ def self.services_available? version: :v1, transport: :grpc
170
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
171
+ package_name = Google::Cloud::AppEngine
172
+ .constants
173
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
174
+ .first
175
+ return false unless package_name
176
+ service_module = Google::Cloud::AppEngine.const_get package_name
177
+ return false unless service_module.const_defined? :Services
178
+ service_module = service_module.const_get :Services
179
+ if transport == :rest
180
+ return false unless service_module.const_defined? :Rest
181
+ service_module = service_module.const_get :Rest
182
+ end
183
+ service_module.const_defined? :Client
184
+ rescue ::LoadError
185
+ false
186
+ end
187
+
116
188
  ##
117
189
  # Create a new client object for Versions.
118
190
  #
@@ -126,6 +198,11 @@ module Google
126
198
  # You can also specify a different transport by passing `:rest` or `:grpc` in
127
199
  # the `transport` parameter.
128
200
  #
201
+ # Raises an exception if the currently installed versioned client gem for the
202
+ # given API version does not support the given transport of the Versions service.
203
+ # You can determine whether the method will succeed by calling
204
+ # {Google::Cloud::AppEngine.versions_available?}.
205
+ #
129
206
  # ## About Versions
130
207
  #
131
208
  # Manages versions of a service.
@@ -147,6 +224,37 @@ module Google
147
224
  service_module.const_get(:Client).new(&block)
148
225
  end
149
226
 
227
+ ##
228
+ # Determines whether the Versions service is supported by the current client.
229
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.versions}.
230
+ # If false, that method will raise an exception. This could happen if the given
231
+ # API version does not exist or does not support the Versions service,
232
+ # or if the versioned client gem needs an update to support the Versions service.
233
+ #
234
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
235
+ # Defaults to `:v1`.
236
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
237
+ # @return [boolean] Whether the service is available.
238
+ #
239
+ def self.versions_available? version: :v1, transport: :grpc
240
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
241
+ package_name = Google::Cloud::AppEngine
242
+ .constants
243
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
244
+ .first
245
+ return false unless package_name
246
+ service_module = Google::Cloud::AppEngine.const_get package_name
247
+ return false unless service_module.const_defined? :Versions
248
+ service_module = service_module.const_get :Versions
249
+ if transport == :rest
250
+ return false unless service_module.const_defined? :Rest
251
+ service_module = service_module.const_get :Rest
252
+ end
253
+ service_module.const_defined? :Client
254
+ rescue ::LoadError
255
+ false
256
+ end
257
+
150
258
  ##
151
259
  # Create a new client object for Instances.
152
260
  #
@@ -160,6 +268,11 @@ module Google
160
268
  # You can also specify a different transport by passing `:rest` or `:grpc` in
161
269
  # the `transport` parameter.
162
270
  #
271
+ # Raises an exception if the currently installed versioned client gem for the
272
+ # given API version does not support the given transport of the Instances service.
273
+ # You can determine whether the method will succeed by calling
274
+ # {Google::Cloud::AppEngine.instances_available?}.
275
+ #
163
276
  # ## About Instances
164
277
  #
165
278
  # Manages instances of a version.
@@ -181,6 +294,37 @@ module Google
181
294
  service_module.const_get(:Client).new(&block)
182
295
  end
183
296
 
297
+ ##
298
+ # Determines whether the Instances service is supported by the current client.
299
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.instances}.
300
+ # If false, that method will raise an exception. This could happen if the given
301
+ # API version does not exist or does not support the Instances service,
302
+ # or if the versioned client gem needs an update to support the Instances service.
303
+ #
304
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
305
+ # Defaults to `:v1`.
306
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
307
+ # @return [boolean] Whether the service is available.
308
+ #
309
+ def self.instances_available? version: :v1, transport: :grpc
310
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
311
+ package_name = Google::Cloud::AppEngine
312
+ .constants
313
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
314
+ .first
315
+ return false unless package_name
316
+ service_module = Google::Cloud::AppEngine.const_get package_name
317
+ return false unless service_module.const_defined? :Instances
318
+ service_module = service_module.const_get :Instances
319
+ if transport == :rest
320
+ return false unless service_module.const_defined? :Rest
321
+ service_module = service_module.const_get :Rest
322
+ end
323
+ service_module.const_defined? :Client
324
+ rescue ::LoadError
325
+ false
326
+ end
327
+
184
328
  ##
185
329
  # Create a new client object for Firewall.
186
330
  #
@@ -194,6 +338,11 @@ module Google
194
338
  # You can also specify a different transport by passing `:rest` or `:grpc` in
195
339
  # the `transport` parameter.
196
340
  #
341
+ # Raises an exception if the currently installed versioned client gem for the
342
+ # given API version does not support the given transport of the Firewall service.
343
+ # You can determine whether the method will succeed by calling
344
+ # {Google::Cloud::AppEngine.firewall_available?}.
345
+ #
197
346
  # ## About Firewall
198
347
  #
199
348
  # Firewall resources are used to define a collection of access control rules
@@ -224,6 +373,37 @@ module Google
224
373
  service_module.const_get(:Client).new(&block)
225
374
  end
226
375
 
376
+ ##
377
+ # Determines whether the Firewall service is supported by the current client.
378
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.firewall}.
379
+ # If false, that method will raise an exception. This could happen if the given
380
+ # API version does not exist or does not support the Firewall service,
381
+ # or if the versioned client gem needs an update to support the Firewall service.
382
+ #
383
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
384
+ # Defaults to `:v1`.
385
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
386
+ # @return [boolean] Whether the service is available.
387
+ #
388
+ def self.firewall_available? version: :v1, transport: :grpc
389
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
390
+ package_name = Google::Cloud::AppEngine
391
+ .constants
392
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
393
+ .first
394
+ return false unless package_name
395
+ service_module = Google::Cloud::AppEngine.const_get package_name
396
+ return false unless service_module.const_defined? :Firewall
397
+ service_module = service_module.const_get :Firewall
398
+ if transport == :rest
399
+ return false unless service_module.const_defined? :Rest
400
+ service_module = service_module.const_get :Rest
401
+ end
402
+ service_module.const_defined? :Client
403
+ rescue ::LoadError
404
+ false
405
+ end
406
+
227
407
  ##
228
408
  # Create a new client object for AuthorizedDomains.
229
409
  #
@@ -237,6 +417,11 @@ module Google
237
417
  # You can also specify a different transport by passing `:rest` or `:grpc` in
238
418
  # the `transport` parameter.
239
419
  #
420
+ # Raises an exception if the currently installed versioned client gem for the
421
+ # given API version does not support the given transport of the AuthorizedDomains service.
422
+ # You can determine whether the method will succeed by calling
423
+ # {Google::Cloud::AppEngine.authorized_domains_available?}.
424
+ #
240
425
  # ## About AuthorizedDomains
241
426
  #
242
427
  # Manages domains a user is authorized to administer. To authorize use of a
@@ -260,6 +445,37 @@ module Google
260
445
  service_module.const_get(:Client).new(&block)
261
446
  end
262
447
 
448
+ ##
449
+ # Determines whether the AuthorizedDomains service is supported by the current client.
450
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.authorized_domains}.
451
+ # If false, that method will raise an exception. This could happen if the given
452
+ # API version does not exist or does not support the AuthorizedDomains service,
453
+ # or if the versioned client gem needs an update to support the AuthorizedDomains service.
454
+ #
455
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
456
+ # Defaults to `:v1`.
457
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
458
+ # @return [boolean] Whether the service is available.
459
+ #
460
+ def self.authorized_domains_available? version: :v1, transport: :grpc
461
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
462
+ package_name = Google::Cloud::AppEngine
463
+ .constants
464
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
465
+ .first
466
+ return false unless package_name
467
+ service_module = Google::Cloud::AppEngine.const_get package_name
468
+ return false unless service_module.const_defined? :AuthorizedDomains
469
+ service_module = service_module.const_get :AuthorizedDomains
470
+ if transport == :rest
471
+ return false unless service_module.const_defined? :Rest
472
+ service_module = service_module.const_get :Rest
473
+ end
474
+ service_module.const_defined? :Client
475
+ rescue ::LoadError
476
+ false
477
+ end
478
+
263
479
  ##
264
480
  # Create a new client object for AuthorizedCertificates.
265
481
  #
@@ -273,6 +489,11 @@ module Google
273
489
  # You can also specify a different transport by passing `:rest` or `:grpc` in
274
490
  # the `transport` parameter.
275
491
  #
492
+ # Raises an exception if the currently installed versioned client gem for the
493
+ # given API version does not support the given transport of the AuthorizedCertificates service.
494
+ # You can determine whether the method will succeed by calling
495
+ # {Google::Cloud::AppEngine.authorized_certificates_available?}.
496
+ #
276
497
  # ## About AuthorizedCertificates
277
498
  #
278
499
  # Manages SSL certificates a user is authorized to administer. A user can
@@ -295,6 +516,37 @@ module Google
295
516
  service_module.const_get(:Client).new(&block)
296
517
  end
297
518
 
519
+ ##
520
+ # Determines whether the AuthorizedCertificates service is supported by the current client.
521
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.authorized_certificates}.
522
+ # If false, that method will raise an exception. This could happen if the given
523
+ # API version does not exist or does not support the AuthorizedCertificates service,
524
+ # or if the versioned client gem needs an update to support the AuthorizedCertificates service.
525
+ #
526
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
527
+ # Defaults to `:v1`.
528
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
529
+ # @return [boolean] Whether the service is available.
530
+ #
531
+ def self.authorized_certificates_available? version: :v1, transport: :grpc
532
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
533
+ package_name = Google::Cloud::AppEngine
534
+ .constants
535
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
536
+ .first
537
+ return false unless package_name
538
+ service_module = Google::Cloud::AppEngine.const_get package_name
539
+ return false unless service_module.const_defined? :AuthorizedCertificates
540
+ service_module = service_module.const_get :AuthorizedCertificates
541
+ if transport == :rest
542
+ return false unless service_module.const_defined? :Rest
543
+ service_module = service_module.const_get :Rest
544
+ end
545
+ service_module.const_defined? :Client
546
+ rescue ::LoadError
547
+ false
548
+ end
549
+
298
550
  ##
299
551
  # Create a new client object for DomainMappings.
300
552
  #
@@ -308,6 +560,11 @@ module Google
308
560
  # You can also specify a different transport by passing `:rest` or `:grpc` in
309
561
  # the `transport` parameter.
310
562
  #
563
+ # Raises an exception if the currently installed versioned client gem for the
564
+ # given API version does not support the given transport of the DomainMappings service.
565
+ # You can determine whether the method will succeed by calling
566
+ # {Google::Cloud::AppEngine.domain_mappings_available?}.
567
+ #
311
568
  # ## About DomainMappings
312
569
  #
313
570
  # Manages domains serving an application.
@@ -329,6 +586,37 @@ module Google
329
586
  service_module.const_get(:Client).new(&block)
330
587
  end
331
588
 
589
+ ##
590
+ # Determines whether the DomainMappings service is supported by the current client.
591
+ # If true, you can retrieve a client object by calling {Google::Cloud::AppEngine.domain_mappings}.
592
+ # If false, that method will raise an exception. This could happen if the given
593
+ # API version does not exist or does not support the DomainMappings service,
594
+ # or if the versioned client gem needs an update to support the DomainMappings service.
595
+ #
596
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
597
+ # Defaults to `:v1`.
598
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
599
+ # @return [boolean] Whether the service is available.
600
+ #
601
+ def self.domain_mappings_available? version: :v1, transport: :grpc
602
+ require "google/cloud/app_engine/#{version.to_s.downcase}"
603
+ package_name = Google::Cloud::AppEngine
604
+ .constants
605
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
606
+ .first
607
+ return false unless package_name
608
+ service_module = Google::Cloud::AppEngine.const_get package_name
609
+ return false unless service_module.const_defined? :DomainMappings
610
+ service_module = service_module.const_get :DomainMappings
611
+ if transport == :rest
612
+ return false unless service_module.const_defined? :Rest
613
+ service_module = service_module.const_get :Rest
614
+ end
615
+ service_module.const_defined? :Client
616
+ rescue ::LoadError
617
+ false
618
+ end
619
+
332
620
  ##
333
621
  # Configure the google-cloud-app_engine library.
334
622
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-app_engine
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-app_engine-v1
@@ -61,7 +60,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
61
60
  licenses:
62
61
  - Apache-2.0
63
62
  metadata: {}
64
- post_install_message:
65
63
  rdoc_options: []
66
64
  require_paths:
67
65
  - lib
@@ -69,15 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
69
67
  requirements:
70
68
  - - ">="
71
69
  - !ruby/object:Gem::Version
72
- version: '2.7'
70
+ version: '3.0'
73
71
  required_rubygems_version: !ruby/object:Gem::Requirement
74
72
  requirements:
75
73
  - - ">="
76
74
  - !ruby/object:Gem::Version
77
75
  version: '0'
78
76
  requirements: []
79
- rubygems_version: 3.5.6
80
- signing_key:
77
+ rubygems_version: 3.6.2
81
78
  specification_version: 4
82
79
  summary: API Client library for the App Engine Admin API
83
80
  test_files: []