google-cloud-api_gateway-v1 0.1.5 → 0.3.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: f7a405676e959de03d45280a97e9954669f1fa6b30ab623ecf03bb20d6b7e74e
4
- data.tar.gz: 966f1df0f9228db5264903b136cefd20312322faa71e986dac393bca414f2da2
3
+ metadata.gz: ab8cd75da5e0c6ad4774a3158d08e352a22f791290adb76e07068bd026e8468c
4
+ data.tar.gz: 41a4afac8e98633d59d4cd8c9ab70a28127470c71bfe19d1f56b2de4b6f71aa6
5
5
  SHA512:
6
- metadata.gz: 0360e3f3baeb2f5c7f518513273a9cbed97fc14861fe4481d9bd070f25511393637a07ca7453b042e4225d037d38e580d4973426f5d729be5f0433ee4fc7ebad
7
- data.tar.gz: 48cf338782e98dbd555b6eeeb80fc2f66aa7325dac3df8fb225f05082867c6d22f2c0b4daaea3479fd692d172c419d803e5837be09905acfbe9b6e25aa114d0e
6
+ metadata.gz: 993b2e809780782ff09006099f72b837122156a7cb64c15f8b96340e4c826bff9c5d968844607042b1d903245516093809ea9486f226198f8cb94f84e65c1c08
7
+ data.tar.gz: 804a9e65bacc675dec3f919f69159dd7b202a90e111af71a11db87638a201a5e989a486b2c4e7d1692ce242bd915307fe08fd52621b9bdc7be561490dafb1d9b
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::ApiGateway::V1::ListGatewaysRequest.new # (request fi
37
37
  response = client.list_gateways request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-api_gateway-v1/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-api_gateway-v1/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/api-gateway/)
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -69,16 +69,21 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
- This library is supported on Ruby 2.5+.
79
+ This library is supported on Ruby 2.6+.
75
80
 
76
81
  Google provides official support for Ruby versions that are actively supported
77
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
78
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
79
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
80
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
81
- about the Ruby support schedule.
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
82
87
 
83
88
  ## Which client should I use?
84
89
 
@@ -252,13 +252,11 @@ module Google
252
252
  # # Call the list_gateways method.
253
253
  # result = client.list_gateways request
254
254
  #
255
- # # The returned object is of type Gapic::PagedEnumerable. You can
256
- # # iterate over all elements by calling #each, and the enumerable
257
- # # will lazily make API calls to fetch subsequent pages. Other
258
- # # methods are also available for managing paging directly.
259
- # result.each do |response|
255
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
256
+ # # over elements, and API calls will be issued to fetch pages as needed.
257
+ # result.each do |item|
260
258
  # # Each element is of type ::Google::Cloud::ApiGateway::V1::Gateway.
261
- # p response
259
+ # p item
262
260
  # end
263
261
  #
264
262
  def list_gateways request, options = nil
@@ -436,14 +434,14 @@ module Google
436
434
  # # Call the create_gateway method.
437
435
  # result = client.create_gateway request
438
436
  #
439
- # # The returned object is of type Gapic::Operation. You can use this
440
- # # object to check the status of an operation, cancel it, or wait
441
- # # for results. Here is how to block until completion:
437
+ # # The returned object is of type Gapic::Operation. You can use it to
438
+ # # check the status of an operation, cancel it, or wait for results.
439
+ # # Here is how to wait for a response.
442
440
  # result.wait_until_done! timeout: 60
443
441
  # if result.response?
444
442
  # p result.response
445
443
  # else
446
- # puts "Error!"
444
+ # puts "No response received."
447
445
  # end
448
446
  #
449
447
  def create_gateway request, options = nil
@@ -535,14 +533,14 @@ module Google
535
533
  # # Call the update_gateway method.
536
534
  # result = client.update_gateway request
537
535
  #
538
- # # The returned object is of type Gapic::Operation. You can use this
539
- # # object to check the status of an operation, cancel it, or wait
540
- # # for results. Here is how to block until completion:
536
+ # # The returned object is of type Gapic::Operation. You can use it to
537
+ # # check the status of an operation, cancel it, or wait for results.
538
+ # # Here is how to wait for a response.
541
539
  # result.wait_until_done! timeout: 60
542
540
  # if result.response?
543
541
  # p result.response
544
542
  # else
545
- # puts "Error!"
543
+ # puts "No response received."
546
544
  # end
547
545
  #
548
546
  def update_gateway request, options = nil
@@ -629,14 +627,14 @@ module Google
629
627
  # # Call the delete_gateway method.
630
628
  # result = client.delete_gateway request
631
629
  #
632
- # # The returned object is of type Gapic::Operation. You can use this
633
- # # object to check the status of an operation, cancel it, or wait
634
- # # for results. Here is how to block until completion:
630
+ # # The returned object is of type Gapic::Operation. You can use it to
631
+ # # check the status of an operation, cancel it, or wait for results.
632
+ # # Here is how to wait for a response.
635
633
  # result.wait_until_done! timeout: 60
636
634
  # if result.response?
637
635
  # p result.response
638
636
  # else
639
- # puts "Error!"
637
+ # puts "No response received."
640
638
  # end
641
639
  #
642
640
  def delete_gateway request, options = nil
@@ -731,13 +729,11 @@ module Google
731
729
  # # Call the list_apis method.
732
730
  # result = client.list_apis request
733
731
  #
734
- # # The returned object is of type Gapic::PagedEnumerable. You can
735
- # # iterate over all elements by calling #each, and the enumerable
736
- # # will lazily make API calls to fetch subsequent pages. Other
737
- # # methods are also available for managing paging directly.
738
- # result.each do |response|
732
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
733
+ # # over elements, and API calls will be issued to fetch pages as needed.
734
+ # result.each do |item|
739
735
  # # Each element is of type ::Google::Cloud::ApiGateway::V1::Api.
740
- # p response
736
+ # p item
741
737
  # end
742
738
  #
743
739
  def list_apis request, options = nil
@@ -915,14 +911,14 @@ module Google
915
911
  # # Call the create_api method.
916
912
  # result = client.create_api request
917
913
  #
918
- # # The returned object is of type Gapic::Operation. You can use this
919
- # # object to check the status of an operation, cancel it, or wait
920
- # # for results. Here is how to block until completion:
914
+ # # The returned object is of type Gapic::Operation. You can use it to
915
+ # # check the status of an operation, cancel it, or wait for results.
916
+ # # Here is how to wait for a response.
921
917
  # result.wait_until_done! timeout: 60
922
918
  # if result.response?
923
919
  # p result.response
924
920
  # else
925
- # puts "Error!"
921
+ # puts "No response received."
926
922
  # end
927
923
  #
928
924
  def create_api request, options = nil
@@ -1014,14 +1010,14 @@ module Google
1014
1010
  # # Call the update_api method.
1015
1011
  # result = client.update_api request
1016
1012
  #
1017
- # # The returned object is of type Gapic::Operation. You can use this
1018
- # # object to check the status of an operation, cancel it, or wait
1019
- # # for results. Here is how to block until completion:
1013
+ # # The returned object is of type Gapic::Operation. You can use it to
1014
+ # # check the status of an operation, cancel it, or wait for results.
1015
+ # # Here is how to wait for a response.
1020
1016
  # result.wait_until_done! timeout: 60
1021
1017
  # if result.response?
1022
1018
  # p result.response
1023
1019
  # else
1024
- # puts "Error!"
1020
+ # puts "No response received."
1025
1021
  # end
1026
1022
  #
1027
1023
  def update_api request, options = nil
@@ -1108,14 +1104,14 @@ module Google
1108
1104
  # # Call the delete_api method.
1109
1105
  # result = client.delete_api request
1110
1106
  #
1111
- # # The returned object is of type Gapic::Operation. You can use this
1112
- # # object to check the status of an operation, cancel it, or wait
1113
- # # for results. Here is how to block until completion:
1107
+ # # The returned object is of type Gapic::Operation. You can use it to
1108
+ # # check the status of an operation, cancel it, or wait for results.
1109
+ # # Here is how to wait for a response.
1114
1110
  # result.wait_until_done! timeout: 60
1115
1111
  # if result.response?
1116
1112
  # p result.response
1117
1113
  # else
1118
- # puts "Error!"
1114
+ # puts "No response received."
1119
1115
  # end
1120
1116
  #
1121
1117
  def delete_api request, options = nil
@@ -1210,13 +1206,11 @@ module Google
1210
1206
  # # Call the list_api_configs method.
1211
1207
  # result = client.list_api_configs request
1212
1208
  #
1213
- # # The returned object is of type Gapic::PagedEnumerable. You can
1214
- # # iterate over all elements by calling #each, and the enumerable
1215
- # # will lazily make API calls to fetch subsequent pages. Other
1216
- # # methods are also available for managing paging directly.
1217
- # result.each do |response|
1209
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1210
+ # # over elements, and API calls will be issued to fetch pages as needed.
1211
+ # result.each do |item|
1218
1212
  # # Each element is of type ::Google::Cloud::ApiGateway::V1::ApiConfig.
1219
- # p response
1213
+ # p item
1220
1214
  # end
1221
1215
  #
1222
1216
  def list_api_configs request, options = nil
@@ -1397,14 +1391,14 @@ module Google
1397
1391
  # # Call the create_api_config method.
1398
1392
  # result = client.create_api_config request
1399
1393
  #
1400
- # # The returned object is of type Gapic::Operation. You can use this
1401
- # # object to check the status of an operation, cancel it, or wait
1402
- # # for results. Here is how to block until completion:
1394
+ # # The returned object is of type Gapic::Operation. You can use it to
1395
+ # # check the status of an operation, cancel it, or wait for results.
1396
+ # # Here is how to wait for a response.
1403
1397
  # result.wait_until_done! timeout: 60
1404
1398
  # if result.response?
1405
1399
  # p result.response
1406
1400
  # else
1407
- # puts "Error!"
1401
+ # puts "No response received."
1408
1402
  # end
1409
1403
  #
1410
1404
  def create_api_config request, options = nil
@@ -1496,14 +1490,14 @@ module Google
1496
1490
  # # Call the update_api_config method.
1497
1491
  # result = client.update_api_config request
1498
1492
  #
1499
- # # The returned object is of type Gapic::Operation. You can use this
1500
- # # object to check the status of an operation, cancel it, or wait
1501
- # # for results. Here is how to block until completion:
1493
+ # # The returned object is of type Gapic::Operation. You can use it to
1494
+ # # check the status of an operation, cancel it, or wait for results.
1495
+ # # Here is how to wait for a response.
1502
1496
  # result.wait_until_done! timeout: 60
1503
1497
  # if result.response?
1504
1498
  # p result.response
1505
1499
  # else
1506
- # puts "Error!"
1500
+ # puts "No response received."
1507
1501
  # end
1508
1502
  #
1509
1503
  def update_api_config request, options = nil
@@ -1590,14 +1584,14 @@ module Google
1590
1584
  # # Call the delete_api_config method.
1591
1585
  # result = client.delete_api_config request
1592
1586
  #
1593
- # # The returned object is of type Gapic::Operation. You can use this
1594
- # # object to check the status of an operation, cancel it, or wait
1595
- # # for results. Here is how to block until completion:
1587
+ # # The returned object is of type Gapic::Operation. You can use it to
1588
+ # # check the status of an operation, cancel it, or wait for results.
1589
+ # # Here is how to wait for a response.
1596
1590
  # result.wait_until_done! timeout: 60
1597
1591
  # if result.response?
1598
1592
  # p result.response
1599
1593
  # else
1600
- # puts "Error!"
1594
+ # puts "No response received."
1601
1595
  # end
1602
1596
  #
1603
1597
  def delete_api_config request, options = nil
@@ -95,6 +95,9 @@ module Google
95
95
  channel_args: @config.channel_args,
96
96
  interceptors: @config.interceptors
97
97
  )
98
+
99
+ # Used by an LRO wrapper for some methods of this service
100
+ @operations_client = self
98
101
  end
99
102
 
100
103
  # Service calls
@@ -155,13 +158,11 @@ module Google
155
158
  # # Call the list_operations method.
156
159
  # result = client.list_operations request
157
160
  #
158
- # # The returned object is of type Gapic::PagedEnumerable. You can
159
- # # iterate over all elements by calling #each, and the enumerable
160
- # # will lazily make API calls to fetch subsequent pages. Other
161
- # # methods are also available for managing paging directly.
162
- # result.each do |response|
161
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
162
+ # # over elements, and API calls will be issued to fetch pages as needed.
163
+ # result.each do |item|
163
164
  # # Each element is of type ::Google::Longrunning::Operation.
164
- # p response
165
+ # p item
165
166
  # end
166
167
  #
167
168
  def list_operations request, options = nil
@@ -250,14 +251,14 @@ module Google
250
251
  # # Call the get_operation method.
251
252
  # result = client.get_operation request
252
253
  #
253
- # # The returned object is of type Gapic::Operation. You can use this
254
- # # object to check the status of an operation, cancel it, or wait
255
- # # for results. Here is how to block until completion:
254
+ # # The returned object is of type Gapic::Operation. You can use it to
255
+ # # check the status of an operation, cancel it, or wait for results.
256
+ # # Here is how to wait for a response.
256
257
  # result.wait_until_done! timeout: 60
257
258
  # if result.response?
258
259
  # p result.response
259
260
  # else
260
- # puts "Error!"
261
+ # puts "No response received."
261
262
  # end
262
263
  #
263
264
  def get_operation request, options = nil
@@ -537,14 +538,14 @@ module Google
537
538
  # # Call the wait_operation method.
538
539
  # result = client.wait_operation request
539
540
  #
540
- # # The returned object is of type Gapic::Operation. You can use this
541
- # # object to check the status of an operation, cancel it, or wait
542
- # # for results. Here is how to block until completion:
541
+ # # The returned object is of type Gapic::Operation. You can use it to
542
+ # # check the status of an operation, cancel it, or wait for results.
543
+ # # Here is how to wait for a response.
543
544
  # result.wait_until_done! timeout: 60
544
545
  # if result.response?
545
546
  # p result.response
546
547
  # else
547
- # puts "Error!"
548
+ # puts "No response received."
548
549
  # end
549
550
  #
550
551
  def wait_operation request, options = nil