google-cloud-eventarc-v1 0.6.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -122,7 +122,7 @@ module Google
122
122
  credentials = @config.credentials
123
123
  # Use self-signed JWT if the endpoint is unchanged from default,
124
124
  # but only if the default endpoint does not have a region prefix.
125
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
125
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
126
126
  !@config.endpoint.split(".").first.include?("-")
127
127
  credentials ||= Credentials.default scope: @config.scope,
128
128
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -206,6 +206,22 @@ module Google
206
206
  # @return [::Google::Cloud::Eventarc::V1::Trigger]
207
207
  #
208
208
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
209
+ #
210
+ # @example Basic example
211
+ # require "google/cloud/eventarc/v1"
212
+ #
213
+ # # Create a client object. The client can be reused for multiple calls.
214
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
215
+ #
216
+ # # Create a request. To set request fields, pass in keyword arguments.
217
+ # request = Google::Cloud::Eventarc::V1::GetTriggerRequest.new
218
+ #
219
+ # # Call the get_trigger method.
220
+ # result = client.get_trigger request
221
+ #
222
+ # # The returned object is of type Google::Cloud::Eventarc::V1::Trigger.
223
+ # p result
224
+ #
209
225
  def get_trigger request, options = nil
210
226
  raise ::ArgumentError, "request must be provided" if request.nil?
211
227
 
@@ -287,6 +303,26 @@ module Google
287
303
  # @return [::Google::Cloud::Eventarc::V1::ListTriggersResponse]
288
304
  #
289
305
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
306
+ #
307
+ # @example Basic example
308
+ # require "google/cloud/eventarc/v1"
309
+ #
310
+ # # Create a client object. The client can be reused for multiple calls.
311
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
312
+ #
313
+ # # Create a request. To set request fields, pass in keyword arguments.
314
+ # request = Google::Cloud::Eventarc::V1::ListTriggersRequest.new
315
+ #
316
+ # # Call the list_triggers method.
317
+ # result = client.list_triggers request
318
+ #
319
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
320
+ # # over elements, and API calls will be issued to fetch pages as needed.
321
+ # result.each do |item|
322
+ # # Each element is of type ::Google::Cloud::Eventarc::V1::Trigger.
323
+ # p item
324
+ # end
325
+ #
290
326
  def list_triggers request, options = nil
291
327
  raise ::ArgumentError, "request must be provided" if request.nil?
292
328
 
@@ -356,6 +392,29 @@ module Google
356
392
  # @return [::Gapic::Operation]
357
393
  #
358
394
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
395
+ #
396
+ # @example Basic example
397
+ # require "google/cloud/eventarc/v1"
398
+ #
399
+ # # Create a client object. The client can be reused for multiple calls.
400
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
401
+ #
402
+ # # Create a request. To set request fields, pass in keyword arguments.
403
+ # request = Google::Cloud::Eventarc::V1::CreateTriggerRequest.new
404
+ #
405
+ # # Call the create_trigger method.
406
+ # result = client.create_trigger request
407
+ #
408
+ # # The returned object is of type Gapic::Operation. You can use it to
409
+ # # check the status of an operation, cancel it, or wait for results.
410
+ # # Here is how to wait for a response.
411
+ # result.wait_until_done! timeout: 60
412
+ # if result.response?
413
+ # p result.response
414
+ # else
415
+ # puts "No response received."
416
+ # end
417
+ #
359
418
  def create_trigger request, options = nil
360
419
  raise ::ArgumentError, "request must be provided" if request.nil?
361
420
 
@@ -429,6 +488,29 @@ module Google
429
488
  # @return [::Gapic::Operation]
430
489
  #
431
490
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
491
+ #
492
+ # @example Basic example
493
+ # require "google/cloud/eventarc/v1"
494
+ #
495
+ # # Create a client object. The client can be reused for multiple calls.
496
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
497
+ #
498
+ # # Create a request. To set request fields, pass in keyword arguments.
499
+ # request = Google::Cloud::Eventarc::V1::UpdateTriggerRequest.new
500
+ #
501
+ # # Call the update_trigger method.
502
+ # result = client.update_trigger request
503
+ #
504
+ # # The returned object is of type Gapic::Operation. You can use it to
505
+ # # check the status of an operation, cancel it, or wait for results.
506
+ # # Here is how to wait for a response.
507
+ # result.wait_until_done! timeout: 60
508
+ # if result.response?
509
+ # p result.response
510
+ # else
511
+ # puts "No response received."
512
+ # end
513
+ #
432
514
  def update_trigger request, options = nil
433
515
  raise ::ArgumentError, "request must be provided" if request.nil?
434
516
 
@@ -501,6 +583,29 @@ module Google
501
583
  # @return [::Gapic::Operation]
502
584
  #
503
585
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
586
+ #
587
+ # @example Basic example
588
+ # require "google/cloud/eventarc/v1"
589
+ #
590
+ # # Create a client object. The client can be reused for multiple calls.
591
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
592
+ #
593
+ # # Create a request. To set request fields, pass in keyword arguments.
594
+ # request = Google::Cloud::Eventarc::V1::DeleteTriggerRequest.new
595
+ #
596
+ # # Call the delete_trigger method.
597
+ # result = client.delete_trigger request
598
+ #
599
+ # # The returned object is of type Gapic::Operation. You can use it to
600
+ # # check the status of an operation, cancel it, or wait for results.
601
+ # # Here is how to wait for a response.
602
+ # result.wait_until_done! timeout: 60
603
+ # if result.response?
604
+ # p result.response
605
+ # else
606
+ # puts "No response received."
607
+ # end
608
+ #
504
609
  def delete_trigger request, options = nil
505
610
  raise ::ArgumentError, "request must be provided" if request.nil?
506
611
 
@@ -564,6 +669,22 @@ module Google
564
669
  # @return [::Google::Cloud::Eventarc::V1::Channel]
565
670
  #
566
671
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
672
+ #
673
+ # @example Basic example
674
+ # require "google/cloud/eventarc/v1"
675
+ #
676
+ # # Create a client object. The client can be reused for multiple calls.
677
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
678
+ #
679
+ # # Create a request. To set request fields, pass in keyword arguments.
680
+ # request = Google::Cloud::Eventarc::V1::GetChannelRequest.new
681
+ #
682
+ # # Call the get_channel method.
683
+ # result = client.get_channel request
684
+ #
685
+ # # The returned object is of type Google::Cloud::Eventarc::V1::Channel.
686
+ # p result
687
+ #
567
688
  def get_channel request, options = nil
568
689
  raise ::ArgumentError, "request must be provided" if request.nil?
569
690
 
@@ -641,6 +762,26 @@ module Google
641
762
  # @return [::Google::Cloud::Eventarc::V1::ListChannelsResponse]
642
763
  #
643
764
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
765
+ #
766
+ # @example Basic example
767
+ # require "google/cloud/eventarc/v1"
768
+ #
769
+ # # Create a client object. The client can be reused for multiple calls.
770
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
771
+ #
772
+ # # Create a request. To set request fields, pass in keyword arguments.
773
+ # request = Google::Cloud::Eventarc::V1::ListChannelsRequest.new
774
+ #
775
+ # # Call the list_channels method.
776
+ # result = client.list_channels request
777
+ #
778
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
779
+ # # over elements, and API calls will be issued to fetch pages as needed.
780
+ # result.each do |item|
781
+ # # Each element is of type ::Google::Cloud::Eventarc::V1::Channel.
782
+ # p item
783
+ # end
784
+ #
644
785
  def list_channels request, options = nil
645
786
  raise ::ArgumentError, "request must be provided" if request.nil?
646
787
 
@@ -710,6 +851,29 @@ module Google
710
851
  # @return [::Gapic::Operation]
711
852
  #
712
853
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
854
+ #
855
+ # @example Basic example
856
+ # require "google/cloud/eventarc/v1"
857
+ #
858
+ # # Create a client object. The client can be reused for multiple calls.
859
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
860
+ #
861
+ # # Create a request. To set request fields, pass in keyword arguments.
862
+ # request = Google::Cloud::Eventarc::V1::CreateChannelRequest.new
863
+ #
864
+ # # Call the create_channel method.
865
+ # result = client.create_channel request
866
+ #
867
+ # # The returned object is of type Gapic::Operation. You can use it to
868
+ # # check the status of an operation, cancel it, or wait for results.
869
+ # # Here is how to wait for a response.
870
+ # result.wait_until_done! timeout: 60
871
+ # if result.response?
872
+ # p result.response
873
+ # else
874
+ # puts "No response received."
875
+ # end
876
+ #
713
877
  def create_channel request, options = nil
714
878
  raise ::ArgumentError, "request must be provided" if request.nil?
715
879
 
@@ -780,6 +944,29 @@ module Google
780
944
  # @return [::Gapic::Operation]
781
945
  #
782
946
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
947
+ #
948
+ # @example Basic example
949
+ # require "google/cloud/eventarc/v1"
950
+ #
951
+ # # Create a client object. The client can be reused for multiple calls.
952
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
953
+ #
954
+ # # Create a request. To set request fields, pass in keyword arguments.
955
+ # request = Google::Cloud::Eventarc::V1::UpdateChannelRequest.new
956
+ #
957
+ # # Call the update_channel method.
958
+ # result = client.update_channel request
959
+ #
960
+ # # The returned object is of type Gapic::Operation. You can use it to
961
+ # # check the status of an operation, cancel it, or wait for results.
962
+ # # Here is how to wait for a response.
963
+ # result.wait_until_done! timeout: 60
964
+ # if result.response?
965
+ # p result.response
966
+ # else
967
+ # puts "No response received."
968
+ # end
969
+ #
783
970
  def update_channel request, options = nil
784
971
  raise ::ArgumentError, "request must be provided" if request.nil?
785
972
 
@@ -846,6 +1033,29 @@ module Google
846
1033
  # @return [::Gapic::Operation]
847
1034
  #
848
1035
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1036
+ #
1037
+ # @example Basic example
1038
+ # require "google/cloud/eventarc/v1"
1039
+ #
1040
+ # # Create a client object. The client can be reused for multiple calls.
1041
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1042
+ #
1043
+ # # Create a request. To set request fields, pass in keyword arguments.
1044
+ # request = Google::Cloud::Eventarc::V1::DeleteChannelRequest.new
1045
+ #
1046
+ # # Call the delete_channel method.
1047
+ # result = client.delete_channel request
1048
+ #
1049
+ # # The returned object is of type Gapic::Operation. You can use it to
1050
+ # # check the status of an operation, cancel it, or wait for results.
1051
+ # # Here is how to wait for a response.
1052
+ # result.wait_until_done! timeout: 60
1053
+ # if result.response?
1054
+ # p result.response
1055
+ # else
1056
+ # puts "No response received."
1057
+ # end
1058
+ #
849
1059
  def delete_channel request, options = nil
850
1060
  raise ::ArgumentError, "request must be provided" if request.nil?
851
1061
 
@@ -909,6 +1119,22 @@ module Google
909
1119
  # @return [::Google::Cloud::Eventarc::V1::Provider]
910
1120
  #
911
1121
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1122
+ #
1123
+ # @example Basic example
1124
+ # require "google/cloud/eventarc/v1"
1125
+ #
1126
+ # # Create a client object. The client can be reused for multiple calls.
1127
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1128
+ #
1129
+ # # Create a request. To set request fields, pass in keyword arguments.
1130
+ # request = Google::Cloud::Eventarc::V1::GetProviderRequest.new
1131
+ #
1132
+ # # Call the get_provider method.
1133
+ # result = client.get_provider request
1134
+ #
1135
+ # # The returned object is of type Google::Cloud::Eventarc::V1::Provider.
1136
+ # p result
1137
+ #
912
1138
  def get_provider request, options = nil
913
1139
  raise ::ArgumentError, "request must be provided" if request.nil?
914
1140
 
@@ -986,6 +1212,26 @@ module Google
986
1212
  # @return [::Google::Cloud::Eventarc::V1::ListProvidersResponse]
987
1213
  #
988
1214
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1215
+ #
1216
+ # @example Basic example
1217
+ # require "google/cloud/eventarc/v1"
1218
+ #
1219
+ # # Create a client object. The client can be reused for multiple calls.
1220
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1221
+ #
1222
+ # # Create a request. To set request fields, pass in keyword arguments.
1223
+ # request = Google::Cloud::Eventarc::V1::ListProvidersRequest.new
1224
+ #
1225
+ # # Call the list_providers method.
1226
+ # result = client.list_providers request
1227
+ #
1228
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1229
+ # # over elements, and API calls will be issued to fetch pages as needed.
1230
+ # result.each do |item|
1231
+ # # Each element is of type ::Google::Cloud::Eventarc::V1::Provider.
1232
+ # p item
1233
+ # end
1234
+ #
989
1235
  def list_providers request, options = nil
990
1236
  raise ::ArgumentError, "request must be provided" if request.nil?
991
1237
 
@@ -1048,6 +1294,22 @@ module Google
1048
1294
  # @return [::Google::Cloud::Eventarc::V1::ChannelConnection]
1049
1295
  #
1050
1296
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1297
+ #
1298
+ # @example Basic example
1299
+ # require "google/cloud/eventarc/v1"
1300
+ #
1301
+ # # Create a client object. The client can be reused for multiple calls.
1302
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1303
+ #
1304
+ # # Create a request. To set request fields, pass in keyword arguments.
1305
+ # request = Google::Cloud::Eventarc::V1::GetChannelConnectionRequest.new
1306
+ #
1307
+ # # Call the get_channel_connection method.
1308
+ # result = client.get_channel_connection request
1309
+ #
1310
+ # # The returned object is of type Google::Cloud::Eventarc::V1::ChannelConnection.
1311
+ # p result
1312
+ #
1051
1313
  def get_channel_connection request, options = nil
1052
1314
  raise ::ArgumentError, "request must be provided" if request.nil?
1053
1315
 
@@ -1120,6 +1382,26 @@ module Google
1120
1382
  # @return [::Google::Cloud::Eventarc::V1::ListChannelConnectionsResponse]
1121
1383
  #
1122
1384
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1385
+ #
1386
+ # @example Basic example
1387
+ # require "google/cloud/eventarc/v1"
1388
+ #
1389
+ # # Create a client object. The client can be reused for multiple calls.
1390
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1391
+ #
1392
+ # # Create a request. To set request fields, pass in keyword arguments.
1393
+ # request = Google::Cloud::Eventarc::V1::ListChannelConnectionsRequest.new
1394
+ #
1395
+ # # Call the list_channel_connections method.
1396
+ # result = client.list_channel_connections request
1397
+ #
1398
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1399
+ # # over elements, and API calls will be issued to fetch pages as needed.
1400
+ # result.each do |item|
1401
+ # # Each element is of type ::Google::Cloud::Eventarc::V1::ChannelConnection.
1402
+ # p item
1403
+ # end
1404
+ #
1123
1405
  def list_channel_connections request, options = nil
1124
1406
  raise ::ArgumentError, "request must be provided" if request.nil?
1125
1407
 
@@ -1186,6 +1468,29 @@ module Google
1186
1468
  # @return [::Gapic::Operation]
1187
1469
  #
1188
1470
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1471
+ #
1472
+ # @example Basic example
1473
+ # require "google/cloud/eventarc/v1"
1474
+ #
1475
+ # # Create a client object. The client can be reused for multiple calls.
1476
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1477
+ #
1478
+ # # Create a request. To set request fields, pass in keyword arguments.
1479
+ # request = Google::Cloud::Eventarc::V1::CreateChannelConnectionRequest.new
1480
+ #
1481
+ # # Call the create_channel_connection method.
1482
+ # result = client.create_channel_connection request
1483
+ #
1484
+ # # The returned object is of type Gapic::Operation. You can use it to
1485
+ # # check the status of an operation, cancel it, or wait for results.
1486
+ # # Here is how to wait for a response.
1487
+ # result.wait_until_done! timeout: 60
1488
+ # if result.response?
1489
+ # p result.response
1490
+ # else
1491
+ # puts "No response received."
1492
+ # end
1493
+ #
1189
1494
  def create_channel_connection request, options = nil
1190
1495
  raise ::ArgumentError, "request must be provided" if request.nil?
1191
1496
 
@@ -1249,6 +1554,29 @@ module Google
1249
1554
  # @return [::Gapic::Operation]
1250
1555
  #
1251
1556
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1557
+ #
1558
+ # @example Basic example
1559
+ # require "google/cloud/eventarc/v1"
1560
+ #
1561
+ # # Create a client object. The client can be reused for multiple calls.
1562
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1563
+ #
1564
+ # # Create a request. To set request fields, pass in keyword arguments.
1565
+ # request = Google::Cloud::Eventarc::V1::DeleteChannelConnectionRequest.new
1566
+ #
1567
+ # # Call the delete_channel_connection method.
1568
+ # result = client.delete_channel_connection request
1569
+ #
1570
+ # # The returned object is of type Gapic::Operation. You can use it to
1571
+ # # check the status of an operation, cancel it, or wait for results.
1572
+ # # Here is how to wait for a response.
1573
+ # result.wait_until_done! timeout: 60
1574
+ # if result.response?
1575
+ # p result.response
1576
+ # else
1577
+ # puts "No response received."
1578
+ # end
1579
+ #
1252
1580
  def delete_channel_connection request, options = nil
1253
1581
  raise ::ArgumentError, "request must be provided" if request.nil?
1254
1582
 
@@ -1312,6 +1640,22 @@ module Google
1312
1640
  # @return [::Google::Cloud::Eventarc::V1::GoogleChannelConfig]
1313
1641
  #
1314
1642
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1643
+ #
1644
+ # @example Basic example
1645
+ # require "google/cloud/eventarc/v1"
1646
+ #
1647
+ # # Create a client object. The client can be reused for multiple calls.
1648
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1649
+ #
1650
+ # # Create a request. To set request fields, pass in keyword arguments.
1651
+ # request = Google::Cloud::Eventarc::V1::GetGoogleChannelConfigRequest.new
1652
+ #
1653
+ # # Call the get_google_channel_config method.
1654
+ # result = client.get_google_channel_config request
1655
+ #
1656
+ # # The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
1657
+ # p result
1658
+ #
1315
1659
  def get_google_channel_config request, options = nil
1316
1660
  raise ::ArgumentError, "request must be provided" if request.nil?
1317
1661
 
@@ -1378,6 +1722,22 @@ module Google
1378
1722
  # @return [::Google::Cloud::Eventarc::V1::GoogleChannelConfig]
1379
1723
  #
1380
1724
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1725
+ #
1726
+ # @example Basic example
1727
+ # require "google/cloud/eventarc/v1"
1728
+ #
1729
+ # # Create a client object. The client can be reused for multiple calls.
1730
+ # client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
1731
+ #
1732
+ # # Create a request. To set request fields, pass in keyword arguments.
1733
+ # request = Google::Cloud::Eventarc::V1::UpdateGoogleChannelConfigRequest.new
1734
+ #
1735
+ # # Call the update_google_channel_config method.
1736
+ # result = client.update_google_channel_config request
1737
+ #
1738
+ # # The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
1739
+ # p result
1740
+ #
1381
1741
  def update_google_channel_config request, options = nil
1382
1742
  raise ::ArgumentError, "request must be provided" if request.nil?
1383
1743
 
@@ -1451,9 +1811,9 @@ module Google
1451
1811
  # * (`String`) The path to a service account key file in JSON format
1452
1812
  # * (`Hash`) A service account key as a Hash
1453
1813
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1454
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1814
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1455
1815
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1456
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1816
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1457
1817
  # * (`nil`) indicating no credentials
1458
1818
  # @return [::Object]
1459
1819
  # @!attribute [rw] scope
@@ -1486,7 +1846,9 @@ module Google
1486
1846
  class Configuration
1487
1847
  extend ::Gapic::Config
1488
1848
 
1489
- config_attr :endpoint, "eventarc.googleapis.com", ::String
1849
+ DEFAULT_ENDPOINT = "eventarc.googleapis.com"
1850
+
1851
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1490
1852
  config_attr :credentials, nil do |value|
1491
1853
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1492
1854
  allowed.any? { |klass| klass === value }
@@ -136,6 +136,26 @@ module Google
136
136
  # @return [::Gapic::Operation]
137
137
  #
138
138
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
139
+ #
140
+ # @example Basic example
141
+ # require "google/longrunning"
142
+ #
143
+ # # Create a client object. The client can be reused for multiple calls.
144
+ # client = Google::Longrunning::Operations::Rest::Client.new
145
+ #
146
+ # # Create a request. To set request fields, pass in keyword arguments.
147
+ # request = Google::Longrunning::ListOperationsRequest.new
148
+ #
149
+ # # Call the list_operations method.
150
+ # result = client.list_operations request
151
+ #
152
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
153
+ # # over elements, and API calls will be issued to fetch pages as needed.
154
+ # result.each do |item|
155
+ # # Each element is of type ::Google::Longrunning::Operation.
156
+ # p item
157
+ # end
158
+ #
139
159
  def list_operations request, options = nil
140
160
  raise ::ArgumentError, "request must be provided" if request.nil?
141
161
 
@@ -201,6 +221,29 @@ module Google
201
221
  # @return [::Gapic::Operation]
202
222
  #
203
223
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
224
+ #
225
+ # @example Basic example
226
+ # require "google/longrunning"
227
+ #
228
+ # # Create a client object. The client can be reused for multiple calls.
229
+ # client = Google::Longrunning::Operations::Rest::Client.new
230
+ #
231
+ # # Create a request. To set request fields, pass in keyword arguments.
232
+ # request = Google::Longrunning::GetOperationRequest.new
233
+ #
234
+ # # Call the get_operation method.
235
+ # result = client.get_operation request
236
+ #
237
+ # # The returned object is of type Gapic::Operation. You can use it to
238
+ # # check the status of an operation, cancel it, or wait for results.
239
+ # # Here is how to wait for a response.
240
+ # result.wait_until_done! timeout: 60
241
+ # if result.response?
242
+ # p result.response
243
+ # else
244
+ # puts "No response received."
245
+ # end
246
+ #
204
247
  def get_operation request, options = nil
205
248
  raise ::ArgumentError, "request must be provided" if request.nil?
206
249
 
@@ -267,6 +310,22 @@ module Google
267
310
  # @return [::Google::Protobuf::Empty]
268
311
  #
269
312
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
313
+ #
314
+ # @example Basic example
315
+ # require "google/longrunning"
316
+ #
317
+ # # Create a client object. The client can be reused for multiple calls.
318
+ # client = Google::Longrunning::Operations::Rest::Client.new
319
+ #
320
+ # # Create a request. To set request fields, pass in keyword arguments.
321
+ # request = Google::Longrunning::DeleteOperationRequest.new
322
+ #
323
+ # # Call the delete_operation method.
324
+ # result = client.delete_operation request
325
+ #
326
+ # # The returned object is of type Google::Protobuf::Empty.
327
+ # p result
328
+ #
270
329
  def delete_operation request, options = nil
271
330
  raise ::ArgumentError, "request must be provided" if request.nil?
272
331
 
@@ -338,6 +397,22 @@ module Google
338
397
  # @return [::Google::Protobuf::Empty]
339
398
  #
340
399
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
400
+ #
401
+ # @example Basic example
402
+ # require "google/longrunning"
403
+ #
404
+ # # Create a client object. The client can be reused for multiple calls.
405
+ # client = Google::Longrunning::Operations::Rest::Client.new
406
+ #
407
+ # # Create a request. To set request fields, pass in keyword arguments.
408
+ # request = Google::Longrunning::CancelOperationRequest.new
409
+ #
410
+ # # Call the cancel_operation method.
411
+ # result = client.cancel_operation request
412
+ #
413
+ # # The returned object is of type Google::Protobuf::Empty.
414
+ # p result
415
+ #
341
416
  def cancel_operation request, options = nil
342
417
  raise ::ArgumentError, "request must be provided" if request.nil?
343
418
 
@@ -411,9 +486,9 @@ module Google
411
486
  # * (`String`) The path to a service account key file in JSON format
412
487
  # * (`Hash`) A service account key as a Hash
413
488
  # * (`Google::Auth::Credentials`) A googleauth credentials object
414
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
489
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
415
490
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
416
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
491
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
417
492
  # * (`nil`) indicating no credentials
418
493
  # @return [::Object]
419
494
  # @!attribute [rw] scope
@@ -446,7 +521,9 @@ module Google
446
521
  class Configuration
447
522
  extend ::Gapic::Config
448
523
 
449
- config_attr :endpoint, "eventarc.googleapis.com", ::String
524
+ DEFAULT_ENDPOINT = "eventarc.googleapis.com"
525
+
526
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
450
527
  config_attr :credentials, nil do |value|
451
528
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
452
529
  allowed.any? { |klass| klass === value }
@@ -567,7 +644,7 @@ module Google
567
644
 
568
645
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_list_operations_request request_pb
569
646
  query_string_params = if query_string_params.any?
570
- query_string_params.to_h { |p| p.split("=", 2) }
647
+ query_string_params.to_h { |p| p.split "=", 2 }
571
648
  else
572
649
  {}
573
650
  end
@@ -605,7 +682,7 @@ module Google
605
682
 
606
683
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_get_operation_request request_pb
607
684
  query_string_params = if query_string_params.any?
608
- query_string_params.to_h { |p| p.split("=", 2) }
685
+ query_string_params.to_h { |p| p.split "=", 2 }
609
686
  else
610
687
  {}
611
688
  end
@@ -643,7 +720,7 @@ module Google
643
720
 
644
721
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_delete_operation_request request_pb
645
722
  query_string_params = if query_string_params.any?
646
- query_string_params.to_h { |p| p.split("=", 2) }
723
+ query_string_params.to_h { |p| p.split "=", 2 }
647
724
  else
648
725
  {}
649
726
  end
@@ -681,7 +758,7 @@ module Google
681
758
 
682
759
  verb, uri, query_string_params, body = OperationsServiceStub.transcode_cancel_operation_request request_pb
683
760
  query_string_params = if query_string_params.any?
684
- query_string_params.to_h { |p| p.split("=", 2) }
761
+ query_string_params.to_h { |p| p.split "=", 2 }
685
762
  else
686
763
  {}
687
764
  end