google-cloud-alloy_db-v1 0.3.0 → 0.4.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: 54b3c308be7e86630f1451edbbead9ea7985164e1aeb4f49989c3d15b18d2256
4
- data.tar.gz: 5dc8c750102179daff9ce2c9aa2d6e28803216ba2b4a9146b99c1fa980618c07
3
+ metadata.gz: af1228f892481520cddcdc975b0d1a4d90e94a503153fd0c87ccb7b4784fcd65
4
+ data.tar.gz: a5a55efcdaddf5ac79abf2bc0535d51caf560c91428d73f1a363426cedd247c8
5
5
  SHA512:
6
- metadata.gz: 05c8c8d973d0e152cc4d28509c9f294daffeef57615040d7dd3e00b3f517f206dcd3175f6b72b8b42023755bdb233dc331e9aeafac5fa4506f77325611ff1235
7
- data.tar.gz: cbc4d140deaa9dd4033bdf04265ed3143dad81a3396c4ff240452f5f9fb6e03f5bfa99a07d508366c475a55f744ad7d489a8a849ee896158bd2b1d979acd99d6
6
+ metadata.gz: 9500502b4537e92e2db6d4e45e05553cf06e74557bb91082bf003c7e6483f8e9a6585d84520b7b99dbbc259b67b62ae8063679302ff25b9097b745da7d1319bf
7
+ data.tar.gz: be8f0b6dc0aba458d1f650f0b70e168d0028095d26ba7ade8d9647b673c19acd4ba6d270f561041da8aba138d577bf0c17dd68f8ccf7e6163b7db493b11d977e
@@ -195,7 +195,8 @@ module Google
195
195
  credentials: credentials,
196
196
  endpoint: @config.endpoint,
197
197
  channel_args: @config.channel_args,
198
- interceptors: @config.interceptors
198
+ interceptors: @config.interceptors,
199
+ channel_pool_config: @config.channel_pool
199
200
  )
200
201
  end
201
202
 
@@ -3497,6 +3498,14 @@ module Google
3497
3498
  end
3498
3499
  end
3499
3500
 
3501
+ ##
3502
+ # Configuration for the channel pool
3503
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
3504
+ #
3505
+ def channel_pool
3506
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
3507
+ end
3508
+
3500
3509
  ##
3501
3510
  # Configuration RPC class for the AlloyDBAdmin API.
3502
3511
  #
@@ -93,7 +93,8 @@ module Google
93
93
  credentials: credentials,
94
94
  endpoint: @config.endpoint,
95
95
  channel_args: @config.channel_args,
96
- interceptors: @config.interceptors
96
+ interceptors: @config.interceptors,
97
+ channel_pool_config: @config.channel_pool
97
98
  )
98
99
 
99
100
  # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,14 @@ module Google
701
702
  end
702
703
  end
703
704
 
705
+ ##
706
+ # Configuration for the channel pool
707
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
708
+ #
709
+ def channel_pool
710
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
711
+ end
712
+
704
713
  ##
705
714
  # Configuration RPC class for the Operations API.
706
715
  #
@@ -253,6 +253,26 @@ module Google
253
253
  # @return [::Google::Cloud::AlloyDB::V1::ListClustersResponse]
254
254
  #
255
255
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
256
+ #
257
+ # @example Basic example
258
+ # require "google/cloud/alloy_db/v1"
259
+ #
260
+ # # Create a client object. The client can be reused for multiple calls.
261
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
262
+ #
263
+ # # Create a request. To set request fields, pass in keyword arguments.
264
+ # request = Google::Cloud::AlloyDB::V1::ListClustersRequest.new
265
+ #
266
+ # # Call the list_clusters method.
267
+ # result = client.list_clusters request
268
+ #
269
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
270
+ # # over elements, and API calls will be issued to fetch pages as needed.
271
+ # result.each do |item|
272
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1::Cluster.
273
+ # p item
274
+ # end
275
+ #
256
276
  def list_clusters request, options = nil
257
277
  raise ::ArgumentError, "request must be provided" if request.nil?
258
278
 
@@ -319,6 +339,22 @@ module Google
319
339
  # @return [::Google::Cloud::AlloyDB::V1::Cluster]
320
340
  #
321
341
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
342
+ #
343
+ # @example Basic example
344
+ # require "google/cloud/alloy_db/v1"
345
+ #
346
+ # # Create a client object. The client can be reused for multiple calls.
347
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
348
+ #
349
+ # # Create a request. To set request fields, pass in keyword arguments.
350
+ # request = Google::Cloud::AlloyDB::V1::GetClusterRequest.new
351
+ #
352
+ # # Call the get_cluster method.
353
+ # result = client.get_cluster request
354
+ #
355
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::Cluster.
356
+ # p result
357
+ #
322
358
  def get_cluster request, options = nil
323
359
  raise ::ArgumentError, "request must be provided" if request.nil?
324
360
 
@@ -404,6 +440,29 @@ module Google
404
440
  # @return [::Gapic::Operation]
405
441
  #
406
442
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
443
+ #
444
+ # @example Basic example
445
+ # require "google/cloud/alloy_db/v1"
446
+ #
447
+ # # Create a client object. The client can be reused for multiple calls.
448
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
449
+ #
450
+ # # Create a request. To set request fields, pass in keyword arguments.
451
+ # request = Google::Cloud::AlloyDB::V1::CreateClusterRequest.new
452
+ #
453
+ # # Call the create_cluster method.
454
+ # result = client.create_cluster request
455
+ #
456
+ # # The returned object is of type Gapic::Operation. You can use it to
457
+ # # check the status of an operation, cancel it, or wait for results.
458
+ # # Here is how to wait for a response.
459
+ # result.wait_until_done! timeout: 60
460
+ # if result.response?
461
+ # p result.response
462
+ # else
463
+ # puts "No response received."
464
+ # end
465
+ #
407
466
  def create_cluster request, options = nil
408
467
  raise ::ArgumentError, "request must be provided" if request.nil?
409
468
 
@@ -494,6 +553,29 @@ module Google
494
553
  # @return [::Gapic::Operation]
495
554
  #
496
555
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
556
+ #
557
+ # @example Basic example
558
+ # require "google/cloud/alloy_db/v1"
559
+ #
560
+ # # Create a client object. The client can be reused for multiple calls.
561
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
562
+ #
563
+ # # Create a request. To set request fields, pass in keyword arguments.
564
+ # request = Google::Cloud::AlloyDB::V1::UpdateClusterRequest.new
565
+ #
566
+ # # Call the update_cluster method.
567
+ # result = client.update_cluster request
568
+ #
569
+ # # The returned object is of type Gapic::Operation. You can use it to
570
+ # # check the status of an operation, cancel it, or wait for results.
571
+ # # Here is how to wait for a response.
572
+ # result.wait_until_done! timeout: 60
573
+ # if result.response?
574
+ # p result.response
575
+ # else
576
+ # puts "No response received."
577
+ # end
578
+ #
497
579
  def update_cluster request, options = nil
498
580
  raise ::ArgumentError, "request must be provided" if request.nil?
499
581
 
@@ -581,6 +663,29 @@ module Google
581
663
  # @return [::Gapic::Operation]
582
664
  #
583
665
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
666
+ #
667
+ # @example Basic example
668
+ # require "google/cloud/alloy_db/v1"
669
+ #
670
+ # # Create a client object. The client can be reused for multiple calls.
671
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
672
+ #
673
+ # # Create a request. To set request fields, pass in keyword arguments.
674
+ # request = Google::Cloud::AlloyDB::V1::DeleteClusterRequest.new
675
+ #
676
+ # # Call the delete_cluster method.
677
+ # result = client.delete_cluster request
678
+ #
679
+ # # The returned object is of type Gapic::Operation. You can use it to
680
+ # # check the status of an operation, cancel it, or wait for results.
681
+ # # Here is how to wait for a response.
682
+ # result.wait_until_done! timeout: 60
683
+ # if result.response?
684
+ # p result.response
685
+ # else
686
+ # puts "No response received."
687
+ # end
688
+ #
584
689
  def delete_cluster request, options = nil
585
690
  raise ::ArgumentError, "request must be provided" if request.nil?
586
691
 
@@ -669,6 +774,29 @@ module Google
669
774
  # @return [::Gapic::Operation]
670
775
  #
671
776
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
777
+ #
778
+ # @example Basic example
779
+ # require "google/cloud/alloy_db/v1"
780
+ #
781
+ # # Create a client object. The client can be reused for multiple calls.
782
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
783
+ #
784
+ # # Create a request. To set request fields, pass in keyword arguments.
785
+ # request = Google::Cloud::AlloyDB::V1::PromoteClusterRequest.new
786
+ #
787
+ # # Call the promote_cluster method.
788
+ # result = client.promote_cluster request
789
+ #
790
+ # # The returned object is of type Gapic::Operation. You can use it to
791
+ # # check the status of an operation, cancel it, or wait for results.
792
+ # # Here is how to wait for a response.
793
+ # result.wait_until_done! timeout: 60
794
+ # if result.response?
795
+ # p result.response
796
+ # else
797
+ # puts "No response received."
798
+ # end
799
+ #
672
800
  def promote_cluster request, options = nil
673
801
  raise ::ArgumentError, "request must be provided" if request.nil?
674
802
 
@@ -762,6 +890,29 @@ module Google
762
890
  # @return [::Gapic::Operation]
763
891
  #
764
892
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
893
+ #
894
+ # @example Basic example
895
+ # require "google/cloud/alloy_db/v1"
896
+ #
897
+ # # Create a client object. The client can be reused for multiple calls.
898
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
899
+ #
900
+ # # Create a request. To set request fields, pass in keyword arguments.
901
+ # request = Google::Cloud::AlloyDB::V1::RestoreClusterRequest.new
902
+ #
903
+ # # Call the restore_cluster method.
904
+ # result = client.restore_cluster request
905
+ #
906
+ # # The returned object is of type Gapic::Operation. You can use it to
907
+ # # check the status of an operation, cancel it, or wait for results.
908
+ # # Here is how to wait for a response.
909
+ # result.wait_until_done! timeout: 60
910
+ # if result.response?
911
+ # p result.response
912
+ # else
913
+ # puts "No response received."
914
+ # end
915
+ #
765
916
  def restore_cluster request, options = nil
766
917
  raise ::ArgumentError, "request must be provided" if request.nil?
767
918
 
@@ -849,6 +1000,29 @@ module Google
849
1000
  # @return [::Gapic::Operation]
850
1001
  #
851
1002
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1003
+ #
1004
+ # @example Basic example
1005
+ # require "google/cloud/alloy_db/v1"
1006
+ #
1007
+ # # Create a client object. The client can be reused for multiple calls.
1008
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1009
+ #
1010
+ # # Create a request. To set request fields, pass in keyword arguments.
1011
+ # request = Google::Cloud::AlloyDB::V1::CreateSecondaryClusterRequest.new
1012
+ #
1013
+ # # Call the create_secondary_cluster method.
1014
+ # result = client.create_secondary_cluster request
1015
+ #
1016
+ # # The returned object is of type Gapic::Operation. You can use it to
1017
+ # # check the status of an operation, cancel it, or wait for results.
1018
+ # # Here is how to wait for a response.
1019
+ # result.wait_until_done! timeout: 60
1020
+ # if result.response?
1021
+ # p result.response
1022
+ # else
1023
+ # puts "No response received."
1024
+ # end
1025
+ #
852
1026
  def create_secondary_cluster request, options = nil
853
1027
  raise ::ArgumentError, "request must be provided" if request.nil?
854
1028
 
@@ -926,6 +1100,26 @@ module Google
926
1100
  # @return [::Google::Cloud::AlloyDB::V1::ListInstancesResponse]
927
1101
  #
928
1102
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1103
+ #
1104
+ # @example Basic example
1105
+ # require "google/cloud/alloy_db/v1"
1106
+ #
1107
+ # # Create a client object. The client can be reused for multiple calls.
1108
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1109
+ #
1110
+ # # Create a request. To set request fields, pass in keyword arguments.
1111
+ # request = Google::Cloud::AlloyDB::V1::ListInstancesRequest.new
1112
+ #
1113
+ # # Call the list_instances method.
1114
+ # result = client.list_instances request
1115
+ #
1116
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1117
+ # # over elements, and API calls will be issued to fetch pages as needed.
1118
+ # result.each do |item|
1119
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1::Instance.
1120
+ # p item
1121
+ # end
1122
+ #
929
1123
  def list_instances request, options = nil
930
1124
  raise ::ArgumentError, "request must be provided" if request.nil?
931
1125
 
@@ -991,6 +1185,22 @@ module Google
991
1185
  # @return [::Google::Cloud::AlloyDB::V1::Instance]
992
1186
  #
993
1187
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1188
+ #
1189
+ # @example Basic example
1190
+ # require "google/cloud/alloy_db/v1"
1191
+ #
1192
+ # # Create a client object. The client can be reused for multiple calls.
1193
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1194
+ #
1195
+ # # Create a request. To set request fields, pass in keyword arguments.
1196
+ # request = Google::Cloud::AlloyDB::V1::GetInstanceRequest.new
1197
+ #
1198
+ # # Call the get_instance method.
1199
+ # result = client.get_instance request
1200
+ #
1201
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::Instance.
1202
+ # p result
1203
+ #
994
1204
  def get_instance request, options = nil
995
1205
  raise ::ArgumentError, "request must be provided" if request.nil?
996
1206
 
@@ -1076,6 +1286,29 @@ module Google
1076
1286
  # @return [::Gapic::Operation]
1077
1287
  #
1078
1288
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1289
+ #
1290
+ # @example Basic example
1291
+ # require "google/cloud/alloy_db/v1"
1292
+ #
1293
+ # # Create a client object. The client can be reused for multiple calls.
1294
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1295
+ #
1296
+ # # Create a request. To set request fields, pass in keyword arguments.
1297
+ # request = Google::Cloud::AlloyDB::V1::CreateInstanceRequest.new
1298
+ #
1299
+ # # Call the create_instance method.
1300
+ # result = client.create_instance request
1301
+ #
1302
+ # # The returned object is of type Gapic::Operation. You can use it to
1303
+ # # check the status of an operation, cancel it, or wait for results.
1304
+ # # Here is how to wait for a response.
1305
+ # result.wait_until_done! timeout: 60
1306
+ # if result.response?
1307
+ # p result.response
1308
+ # else
1309
+ # puts "No response received."
1310
+ # end
1311
+ #
1079
1312
  def create_instance request, options = nil
1080
1313
  raise ::ArgumentError, "request must be provided" if request.nil?
1081
1314
 
@@ -1162,6 +1395,29 @@ module Google
1162
1395
  # @return [::Gapic::Operation]
1163
1396
  #
1164
1397
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1398
+ #
1399
+ # @example Basic example
1400
+ # require "google/cloud/alloy_db/v1"
1401
+ #
1402
+ # # Create a client object. The client can be reused for multiple calls.
1403
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1404
+ #
1405
+ # # Create a request. To set request fields, pass in keyword arguments.
1406
+ # request = Google::Cloud::AlloyDB::V1::CreateSecondaryInstanceRequest.new
1407
+ #
1408
+ # # Call the create_secondary_instance method.
1409
+ # result = client.create_secondary_instance request
1410
+ #
1411
+ # # The returned object is of type Gapic::Operation. You can use it to
1412
+ # # check the status of an operation, cancel it, or wait for results.
1413
+ # # Here is how to wait for a response.
1414
+ # result.wait_until_done! timeout: 60
1415
+ # if result.response?
1416
+ # p result.response
1417
+ # else
1418
+ # puts "No response received."
1419
+ # end
1420
+ #
1165
1421
  def create_secondary_instance request, options = nil
1166
1422
  raise ::ArgumentError, "request must be provided" if request.nil?
1167
1423
 
@@ -1250,6 +1506,29 @@ module Google
1250
1506
  # @return [::Gapic::Operation]
1251
1507
  #
1252
1508
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1509
+ #
1510
+ # @example Basic example
1511
+ # require "google/cloud/alloy_db/v1"
1512
+ #
1513
+ # # Create a client object. The client can be reused for multiple calls.
1514
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1515
+ #
1516
+ # # Create a request. To set request fields, pass in keyword arguments.
1517
+ # request = Google::Cloud::AlloyDB::V1::BatchCreateInstancesRequest.new
1518
+ #
1519
+ # # Call the batch_create_instances method.
1520
+ # result = client.batch_create_instances request
1521
+ #
1522
+ # # The returned object is of type Gapic::Operation. You can use it to
1523
+ # # check the status of an operation, cancel it, or wait for results.
1524
+ # # Here is how to wait for a response.
1525
+ # result.wait_until_done! timeout: 60
1526
+ # if result.response?
1527
+ # p result.response
1528
+ # else
1529
+ # puts "No response received."
1530
+ # end
1531
+ #
1253
1532
  def batch_create_instances request, options = nil
1254
1533
  raise ::ArgumentError, "request must be provided" if request.nil?
1255
1534
 
@@ -1340,6 +1619,29 @@ module Google
1340
1619
  # @return [::Gapic::Operation]
1341
1620
  #
1342
1621
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1622
+ #
1623
+ # @example Basic example
1624
+ # require "google/cloud/alloy_db/v1"
1625
+ #
1626
+ # # Create a client object. The client can be reused for multiple calls.
1627
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1628
+ #
1629
+ # # Create a request. To set request fields, pass in keyword arguments.
1630
+ # request = Google::Cloud::AlloyDB::V1::UpdateInstanceRequest.new
1631
+ #
1632
+ # # Call the update_instance method.
1633
+ # result = client.update_instance request
1634
+ #
1635
+ # # The returned object is of type Gapic::Operation. You can use it to
1636
+ # # check the status of an operation, cancel it, or wait for results.
1637
+ # # Here is how to wait for a response.
1638
+ # result.wait_until_done! timeout: 60
1639
+ # if result.response?
1640
+ # p result.response
1641
+ # else
1642
+ # puts "No response received."
1643
+ # end
1644
+ #
1343
1645
  def update_instance request, options = nil
1344
1646
  raise ::ArgumentError, "request must be provided" if request.nil?
1345
1647
 
@@ -1425,6 +1727,29 @@ module Google
1425
1727
  # @return [::Gapic::Operation]
1426
1728
  #
1427
1729
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1730
+ #
1731
+ # @example Basic example
1732
+ # require "google/cloud/alloy_db/v1"
1733
+ #
1734
+ # # Create a client object. The client can be reused for multiple calls.
1735
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1736
+ #
1737
+ # # Create a request. To set request fields, pass in keyword arguments.
1738
+ # request = Google::Cloud::AlloyDB::V1::DeleteInstanceRequest.new
1739
+ #
1740
+ # # Call the delete_instance method.
1741
+ # result = client.delete_instance request
1742
+ #
1743
+ # # The returned object is of type Gapic::Operation. You can use it to
1744
+ # # check the status of an operation, cancel it, or wait for results.
1745
+ # # Here is how to wait for a response.
1746
+ # result.wait_until_done! timeout: 60
1747
+ # if result.response?
1748
+ # p result.response
1749
+ # else
1750
+ # puts "No response received."
1751
+ # end
1752
+ #
1428
1753
  def delete_instance request, options = nil
1429
1754
  raise ::ArgumentError, "request must be provided" if request.nil?
1430
1755
 
@@ -1508,6 +1833,29 @@ module Google
1508
1833
  # @return [::Gapic::Operation]
1509
1834
  #
1510
1835
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1836
+ #
1837
+ # @example Basic example
1838
+ # require "google/cloud/alloy_db/v1"
1839
+ #
1840
+ # # Create a client object. The client can be reused for multiple calls.
1841
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1842
+ #
1843
+ # # Create a request. To set request fields, pass in keyword arguments.
1844
+ # request = Google::Cloud::AlloyDB::V1::FailoverInstanceRequest.new
1845
+ #
1846
+ # # Call the failover_instance method.
1847
+ # result = client.failover_instance request
1848
+ #
1849
+ # # The returned object is of type Gapic::Operation. You can use it to
1850
+ # # check the status of an operation, cancel it, or wait for results.
1851
+ # # Here is how to wait for a response.
1852
+ # result.wait_until_done! timeout: 60
1853
+ # if result.response?
1854
+ # p result.response
1855
+ # else
1856
+ # puts "No response received."
1857
+ # end
1858
+ #
1511
1859
  def failover_instance request, options = nil
1512
1860
  raise ::ArgumentError, "request must be provided" if request.nil?
1513
1861
 
@@ -1593,6 +1941,29 @@ module Google
1593
1941
  # @return [::Gapic::Operation]
1594
1942
  #
1595
1943
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1944
+ #
1945
+ # @example Basic example
1946
+ # require "google/cloud/alloy_db/v1"
1947
+ #
1948
+ # # Create a client object. The client can be reused for multiple calls.
1949
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
1950
+ #
1951
+ # # Create a request. To set request fields, pass in keyword arguments.
1952
+ # request = Google::Cloud::AlloyDB::V1::InjectFaultRequest.new
1953
+ #
1954
+ # # Call the inject_fault method.
1955
+ # result = client.inject_fault request
1956
+ #
1957
+ # # The returned object is of type Gapic::Operation. You can use it to
1958
+ # # check the status of an operation, cancel it, or wait for results.
1959
+ # # Here is how to wait for a response.
1960
+ # result.wait_until_done! timeout: 60
1961
+ # if result.response?
1962
+ # p result.response
1963
+ # else
1964
+ # puts "No response received."
1965
+ # end
1966
+ #
1596
1967
  def inject_fault request, options = nil
1597
1968
  raise ::ArgumentError, "request must be provided" if request.nil?
1598
1969
 
@@ -1675,6 +2046,29 @@ module Google
1675
2046
  # @return [::Gapic::Operation]
1676
2047
  #
1677
2048
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2049
+ #
2050
+ # @example Basic example
2051
+ # require "google/cloud/alloy_db/v1"
2052
+ #
2053
+ # # Create a client object. The client can be reused for multiple calls.
2054
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2055
+ #
2056
+ # # Create a request. To set request fields, pass in keyword arguments.
2057
+ # request = Google::Cloud::AlloyDB::V1::RestartInstanceRequest.new
2058
+ #
2059
+ # # Call the restart_instance method.
2060
+ # result = client.restart_instance request
2061
+ #
2062
+ # # The returned object is of type Gapic::Operation. You can use it to
2063
+ # # check the status of an operation, cancel it, or wait for results.
2064
+ # # Here is how to wait for a response.
2065
+ # result.wait_until_done! timeout: 60
2066
+ # if result.response?
2067
+ # p result.response
2068
+ # else
2069
+ # puts "No response received."
2070
+ # end
2071
+ #
1678
2072
  def restart_instance request, options = nil
1679
2073
  raise ::ArgumentError, "request must be provided" if request.nil?
1680
2074
 
@@ -1747,6 +2141,26 @@ module Google
1747
2141
  # @return [::Google::Cloud::AlloyDB::V1::ListBackupsResponse]
1748
2142
  #
1749
2143
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2144
+ #
2145
+ # @example Basic example
2146
+ # require "google/cloud/alloy_db/v1"
2147
+ #
2148
+ # # Create a client object. The client can be reused for multiple calls.
2149
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2150
+ #
2151
+ # # Create a request. To set request fields, pass in keyword arguments.
2152
+ # request = Google::Cloud::AlloyDB::V1::ListBackupsRequest.new
2153
+ #
2154
+ # # Call the list_backups method.
2155
+ # result = client.list_backups request
2156
+ #
2157
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2158
+ # # over elements, and API calls will be issued to fetch pages as needed.
2159
+ # result.each do |item|
2160
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1::Backup.
2161
+ # p item
2162
+ # end
2163
+ #
1750
2164
  def list_backups request, options = nil
1751
2165
  raise ::ArgumentError, "request must be provided" if request.nil?
1752
2166
 
@@ -1809,6 +2223,22 @@ module Google
1809
2223
  # @return [::Google::Cloud::AlloyDB::V1::Backup]
1810
2224
  #
1811
2225
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2226
+ #
2227
+ # @example Basic example
2228
+ # require "google/cloud/alloy_db/v1"
2229
+ #
2230
+ # # Create a client object. The client can be reused for multiple calls.
2231
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2232
+ #
2233
+ # # Create a request. To set request fields, pass in keyword arguments.
2234
+ # request = Google::Cloud::AlloyDB::V1::GetBackupRequest.new
2235
+ #
2236
+ # # Call the get_backup method.
2237
+ # result = client.get_backup request
2238
+ #
2239
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::Backup.
2240
+ # p result
2241
+ #
1812
2242
  def get_backup request, options = nil
1813
2243
  raise ::ArgumentError, "request must be provided" if request.nil?
1814
2244
 
@@ -1892,6 +2322,29 @@ module Google
1892
2322
  # @return [::Gapic::Operation]
1893
2323
  #
1894
2324
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2325
+ #
2326
+ # @example Basic example
2327
+ # require "google/cloud/alloy_db/v1"
2328
+ #
2329
+ # # Create a client object. The client can be reused for multiple calls.
2330
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2331
+ #
2332
+ # # Create a request. To set request fields, pass in keyword arguments.
2333
+ # request = Google::Cloud::AlloyDB::V1::CreateBackupRequest.new
2334
+ #
2335
+ # # Call the create_backup method.
2336
+ # result = client.create_backup request
2337
+ #
2338
+ # # The returned object is of type Gapic::Operation. You can use it to
2339
+ # # check the status of an operation, cancel it, or wait for results.
2340
+ # # Here is how to wait for a response.
2341
+ # result.wait_until_done! timeout: 60
2342
+ # if result.response?
2343
+ # p result.response
2344
+ # else
2345
+ # puts "No response received."
2346
+ # end
2347
+ #
1895
2348
  def create_backup request, options = nil
1896
2349
  raise ::ArgumentError, "request must be provided" if request.nil?
1897
2350
 
@@ -1981,6 +2434,29 @@ module Google
1981
2434
  # @return [::Gapic::Operation]
1982
2435
  #
1983
2436
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2437
+ #
2438
+ # @example Basic example
2439
+ # require "google/cloud/alloy_db/v1"
2440
+ #
2441
+ # # Create a client object. The client can be reused for multiple calls.
2442
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2443
+ #
2444
+ # # Create a request. To set request fields, pass in keyword arguments.
2445
+ # request = Google::Cloud::AlloyDB::V1::UpdateBackupRequest.new
2446
+ #
2447
+ # # Call the update_backup method.
2448
+ # result = client.update_backup request
2449
+ #
2450
+ # # The returned object is of type Gapic::Operation. You can use it to
2451
+ # # check the status of an operation, cancel it, or wait for results.
2452
+ # # Here is how to wait for a response.
2453
+ # result.wait_until_done! timeout: 60
2454
+ # if result.response?
2455
+ # p result.response
2456
+ # else
2457
+ # puts "No response received."
2458
+ # end
2459
+ #
1984
2460
  def update_backup request, options = nil
1985
2461
  raise ::ArgumentError, "request must be provided" if request.nil?
1986
2462
 
@@ -2066,6 +2542,29 @@ module Google
2066
2542
  # @return [::Gapic::Operation]
2067
2543
  #
2068
2544
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2545
+ #
2546
+ # @example Basic example
2547
+ # require "google/cloud/alloy_db/v1"
2548
+ #
2549
+ # # Create a client object. The client can be reused for multiple calls.
2550
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2551
+ #
2552
+ # # Create a request. To set request fields, pass in keyword arguments.
2553
+ # request = Google::Cloud::AlloyDB::V1::DeleteBackupRequest.new
2554
+ #
2555
+ # # Call the delete_backup method.
2556
+ # result = client.delete_backup request
2557
+ #
2558
+ # # The returned object is of type Gapic::Operation. You can use it to
2559
+ # # check the status of an operation, cancel it, or wait for results.
2560
+ # # Here is how to wait for a response.
2561
+ # result.wait_until_done! timeout: 60
2562
+ # if result.response?
2563
+ # p result.response
2564
+ # else
2565
+ # puts "No response received."
2566
+ # end
2567
+ #
2069
2568
  def delete_backup request, options = nil
2070
2569
  raise ::ArgumentError, "request must be provided" if request.nil?
2071
2570
 
@@ -2140,6 +2639,26 @@ module Google
2140
2639
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>]
2141
2640
  #
2142
2641
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2642
+ #
2643
+ # @example Basic example
2644
+ # require "google/cloud/alloy_db/v1"
2645
+ #
2646
+ # # Create a client object. The client can be reused for multiple calls.
2647
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2648
+ #
2649
+ # # Create a request. To set request fields, pass in keyword arguments.
2650
+ # request = Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsRequest.new
2651
+ #
2652
+ # # Call the list_supported_database_flags method.
2653
+ # result = client.list_supported_database_flags request
2654
+ #
2655
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2656
+ # # over elements, and API calls will be issued to fetch pages as needed.
2657
+ # result.each do |item|
2658
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag.
2659
+ # p item
2660
+ # end
2661
+ #
2143
2662
  def list_supported_database_flags request, options = nil
2144
2663
  raise ::ArgumentError, "request must be provided" if request.nil?
2145
2664
 
@@ -2212,6 +2731,26 @@ module Google
2212
2731
  # @return [::Google::Cloud::AlloyDB::V1::ListUsersResponse]
2213
2732
  #
2214
2733
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2734
+ #
2735
+ # @example Basic example
2736
+ # require "google/cloud/alloy_db/v1"
2737
+ #
2738
+ # # Create a client object. The client can be reused for multiple calls.
2739
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2740
+ #
2741
+ # # Create a request. To set request fields, pass in keyword arguments.
2742
+ # request = Google::Cloud::AlloyDB::V1::ListUsersRequest.new
2743
+ #
2744
+ # # Call the list_users method.
2745
+ # result = client.list_users request
2746
+ #
2747
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2748
+ # # over elements, and API calls will be issued to fetch pages as needed.
2749
+ # result.each do |item|
2750
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1::User.
2751
+ # p item
2752
+ # end
2753
+ #
2215
2754
  def list_users request, options = nil
2216
2755
  raise ::ArgumentError, "request must be provided" if request.nil?
2217
2756
 
@@ -2275,6 +2814,22 @@ module Google
2275
2814
  # @return [::Google::Cloud::AlloyDB::V1::User]
2276
2815
  #
2277
2816
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2817
+ #
2818
+ # @example Basic example
2819
+ # require "google/cloud/alloy_db/v1"
2820
+ #
2821
+ # # Create a client object. The client can be reused for multiple calls.
2822
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2823
+ #
2824
+ # # Create a request. To set request fields, pass in keyword arguments.
2825
+ # request = Google::Cloud::AlloyDB::V1::GetUserRequest.new
2826
+ #
2827
+ # # Call the get_user method.
2828
+ # result = client.get_user request
2829
+ #
2830
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::User.
2831
+ # p result
2832
+ #
2278
2833
  def get_user request, options = nil
2279
2834
  raise ::ArgumentError, "request must be provided" if request.nil?
2280
2835
 
@@ -2358,6 +2913,22 @@ module Google
2358
2913
  # @return [::Google::Cloud::AlloyDB::V1::User]
2359
2914
  #
2360
2915
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2916
+ #
2917
+ # @example Basic example
2918
+ # require "google/cloud/alloy_db/v1"
2919
+ #
2920
+ # # Create a client object. The client can be reused for multiple calls.
2921
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
2922
+ #
2923
+ # # Create a request. To set request fields, pass in keyword arguments.
2924
+ # request = Google::Cloud::AlloyDB::V1::CreateUserRequest.new
2925
+ #
2926
+ # # Call the create_user method.
2927
+ # result = client.create_user request
2928
+ #
2929
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::User.
2930
+ # p result
2931
+ #
2361
2932
  def create_user request, options = nil
2362
2933
  raise ::ArgumentError, "request must be provided" if request.nil?
2363
2934
 
@@ -2445,6 +3016,22 @@ module Google
2445
3016
  # @return [::Google::Cloud::AlloyDB::V1::User]
2446
3017
  #
2447
3018
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3019
+ #
3020
+ # @example Basic example
3021
+ # require "google/cloud/alloy_db/v1"
3022
+ #
3023
+ # # Create a client object. The client can be reused for multiple calls.
3024
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
3025
+ #
3026
+ # # Create a request. To set request fields, pass in keyword arguments.
3027
+ # request = Google::Cloud::AlloyDB::V1::UpdateUserRequest.new
3028
+ #
3029
+ # # Call the update_user method.
3030
+ # result = client.update_user request
3031
+ #
3032
+ # # The returned object is of type Google::Cloud::AlloyDB::V1::User.
3033
+ # p result
3034
+ #
2448
3035
  def update_user request, options = nil
2449
3036
  raise ::ArgumentError, "request must be provided" if request.nil?
2450
3037
 
@@ -2525,6 +3112,22 @@ module Google
2525
3112
  # @return [::Google::Protobuf::Empty]
2526
3113
  #
2527
3114
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3115
+ #
3116
+ # @example Basic example
3117
+ # require "google/cloud/alloy_db/v1"
3118
+ #
3119
+ # # Create a client object. The client can be reused for multiple calls.
3120
+ # client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::Client.new
3121
+ #
3122
+ # # Create a request. To set request fields, pass in keyword arguments.
3123
+ # request = Google::Cloud::AlloyDB::V1::DeleteUserRequest.new
3124
+ #
3125
+ # # Call the delete_user method.
3126
+ # result = client.delete_user request
3127
+ #
3128
+ # # The returned object is of type Google::Protobuf::Empty.
3129
+ # p result
3130
+ #
2528
3131
  def delete_user request, options = nil
2529
3132
  raise ::ArgumentError, "request must be provided" if request.nil?
2530
3133
 
@@ -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
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AlloyDB
23
23
  module V1
24
- VERSION = "0.3.0"
24
+ VERSION = "0.4.0"
25
25
  end
26
26
  end
27
27
  end
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-alloy_db-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-19 00:00:00.000000000 Z
11
+ date: 2023-09-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.20.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.20.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
271
271
  - !ruby/object:Gem::Version
272
272
  version: '0'
273
273
  requirements: []
274
- rubygems_version: 3.4.2
274
+ rubygems_version: 3.4.19
275
275
  signing_key:
276
276
  specification_version: 4
277
277
  summary: AlloyDB for PostgreSQL is an open source-compatible database service that