google-cloud-alloy_db-v1beta 0.3.0 → 0.5.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.
@@ -273,6 +273,26 @@ module Google
273
273
  # @return [::Google::Cloud::AlloyDB::V1beta::ListClustersResponse]
274
274
  #
275
275
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
276
+ #
277
+ # @example Basic example
278
+ # require "google/cloud/alloy_db/v1beta"
279
+ #
280
+ # # Create a client object. The client can be reused for multiple calls.
281
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
282
+ #
283
+ # # Create a request. To set request fields, pass in keyword arguments.
284
+ # request = Google::Cloud::AlloyDB::V1beta::ListClustersRequest.new
285
+ #
286
+ # # Call the list_clusters method.
287
+ # result = client.list_clusters request
288
+ #
289
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
290
+ # # over elements, and API calls will be issued to fetch pages as needed.
291
+ # result.each do |item|
292
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1beta::Cluster.
293
+ # p item
294
+ # end
295
+ #
276
296
  def list_clusters request, options = nil
277
297
  raise ::ArgumentError, "request must be provided" if request.nil?
278
298
 
@@ -339,6 +359,22 @@ module Google
339
359
  # @return [::Google::Cloud::AlloyDB::V1beta::Cluster]
340
360
  #
341
361
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
362
+ #
363
+ # @example Basic example
364
+ # require "google/cloud/alloy_db/v1beta"
365
+ #
366
+ # # Create a client object. The client can be reused for multiple calls.
367
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
368
+ #
369
+ # # Create a request. To set request fields, pass in keyword arguments.
370
+ # request = Google::Cloud::AlloyDB::V1beta::GetClusterRequest.new
371
+ #
372
+ # # Call the get_cluster method.
373
+ # result = client.get_cluster request
374
+ #
375
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::Cluster.
376
+ # p result
377
+ #
342
378
  def get_cluster request, options = nil
343
379
  raise ::ArgumentError, "request must be provided" if request.nil?
344
380
 
@@ -424,6 +460,29 @@ module Google
424
460
  # @return [::Gapic::Operation]
425
461
  #
426
462
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
463
+ #
464
+ # @example Basic example
465
+ # require "google/cloud/alloy_db/v1beta"
466
+ #
467
+ # # Create a client object. The client can be reused for multiple calls.
468
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
469
+ #
470
+ # # Create a request. To set request fields, pass in keyword arguments.
471
+ # request = Google::Cloud::AlloyDB::V1beta::CreateClusterRequest.new
472
+ #
473
+ # # Call the create_cluster method.
474
+ # result = client.create_cluster request
475
+ #
476
+ # # The returned object is of type Gapic::Operation. You can use it to
477
+ # # check the status of an operation, cancel it, or wait for results.
478
+ # # Here is how to wait for a response.
479
+ # result.wait_until_done! timeout: 60
480
+ # if result.response?
481
+ # p result.response
482
+ # else
483
+ # puts "No response received."
484
+ # end
485
+ #
427
486
  def create_cluster request, options = nil
428
487
  raise ::ArgumentError, "request must be provided" if request.nil?
429
488
 
@@ -514,6 +573,29 @@ module Google
514
573
  # @return [::Gapic::Operation]
515
574
  #
516
575
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
576
+ #
577
+ # @example Basic example
578
+ # require "google/cloud/alloy_db/v1beta"
579
+ #
580
+ # # Create a client object. The client can be reused for multiple calls.
581
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
582
+ #
583
+ # # Create a request. To set request fields, pass in keyword arguments.
584
+ # request = Google::Cloud::AlloyDB::V1beta::UpdateClusterRequest.new
585
+ #
586
+ # # Call the update_cluster method.
587
+ # result = client.update_cluster request
588
+ #
589
+ # # The returned object is of type Gapic::Operation. You can use it to
590
+ # # check the status of an operation, cancel it, or wait for results.
591
+ # # Here is how to wait for a response.
592
+ # result.wait_until_done! timeout: 60
593
+ # if result.response?
594
+ # p result.response
595
+ # else
596
+ # puts "No response received."
597
+ # end
598
+ #
517
599
  def update_cluster request, options = nil
518
600
  raise ::ArgumentError, "request must be provided" if request.nil?
519
601
 
@@ -601,6 +683,29 @@ module Google
601
683
  # @return [::Gapic::Operation]
602
684
  #
603
685
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
686
+ #
687
+ # @example Basic example
688
+ # require "google/cloud/alloy_db/v1beta"
689
+ #
690
+ # # Create a client object. The client can be reused for multiple calls.
691
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
692
+ #
693
+ # # Create a request. To set request fields, pass in keyword arguments.
694
+ # request = Google::Cloud::AlloyDB::V1beta::DeleteClusterRequest.new
695
+ #
696
+ # # Call the delete_cluster method.
697
+ # result = client.delete_cluster request
698
+ #
699
+ # # The returned object is of type Gapic::Operation. You can use it to
700
+ # # check the status of an operation, cancel it, or wait for results.
701
+ # # Here is how to wait for a response.
702
+ # result.wait_until_done! timeout: 60
703
+ # if result.response?
704
+ # p result.response
705
+ # else
706
+ # puts "No response received."
707
+ # end
708
+ #
604
709
  def delete_cluster request, options = nil
605
710
  raise ::ArgumentError, "request must be provided" if request.nil?
606
711
 
@@ -689,6 +794,29 @@ module Google
689
794
  # @return [::Gapic::Operation]
690
795
  #
691
796
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
797
+ #
798
+ # @example Basic example
799
+ # require "google/cloud/alloy_db/v1beta"
800
+ #
801
+ # # Create a client object. The client can be reused for multiple calls.
802
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
803
+ #
804
+ # # Create a request. To set request fields, pass in keyword arguments.
805
+ # request = Google::Cloud::AlloyDB::V1beta::PromoteClusterRequest.new
806
+ #
807
+ # # Call the promote_cluster method.
808
+ # result = client.promote_cluster request
809
+ #
810
+ # # The returned object is of type Gapic::Operation. You can use it to
811
+ # # check the status of an operation, cancel it, or wait for results.
812
+ # # Here is how to wait for a response.
813
+ # result.wait_until_done! timeout: 60
814
+ # if result.response?
815
+ # p result.response
816
+ # else
817
+ # puts "No response received."
818
+ # end
819
+ #
692
820
  def promote_cluster request, options = nil
693
821
  raise ::ArgumentError, "request must be provided" if request.nil?
694
822
 
@@ -782,6 +910,29 @@ module Google
782
910
  # @return [::Gapic::Operation]
783
911
  #
784
912
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
913
+ #
914
+ # @example Basic example
915
+ # require "google/cloud/alloy_db/v1beta"
916
+ #
917
+ # # Create a client object. The client can be reused for multiple calls.
918
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
919
+ #
920
+ # # Create a request. To set request fields, pass in keyword arguments.
921
+ # request = Google::Cloud::AlloyDB::V1beta::RestoreClusterRequest.new
922
+ #
923
+ # # Call the restore_cluster method.
924
+ # result = client.restore_cluster request
925
+ #
926
+ # # The returned object is of type Gapic::Operation. You can use it to
927
+ # # check the status of an operation, cancel it, or wait for results.
928
+ # # Here is how to wait for a response.
929
+ # result.wait_until_done! timeout: 60
930
+ # if result.response?
931
+ # p result.response
932
+ # else
933
+ # puts "No response received."
934
+ # end
935
+ #
785
936
  def restore_cluster request, options = nil
786
937
  raise ::ArgumentError, "request must be provided" if request.nil?
787
938
 
@@ -869,6 +1020,29 @@ module Google
869
1020
  # @return [::Gapic::Operation]
870
1021
  #
871
1022
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1023
+ #
1024
+ # @example Basic example
1025
+ # require "google/cloud/alloy_db/v1beta"
1026
+ #
1027
+ # # Create a client object. The client can be reused for multiple calls.
1028
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1029
+ #
1030
+ # # Create a request. To set request fields, pass in keyword arguments.
1031
+ # request = Google::Cloud::AlloyDB::V1beta::CreateSecondaryClusterRequest.new
1032
+ #
1033
+ # # Call the create_secondary_cluster method.
1034
+ # result = client.create_secondary_cluster request
1035
+ #
1036
+ # # The returned object is of type Gapic::Operation. You can use it to
1037
+ # # check the status of an operation, cancel it, or wait for results.
1038
+ # # Here is how to wait for a response.
1039
+ # result.wait_until_done! timeout: 60
1040
+ # if result.response?
1041
+ # p result.response
1042
+ # else
1043
+ # puts "No response received."
1044
+ # end
1045
+ #
872
1046
  def create_secondary_cluster request, options = nil
873
1047
  raise ::ArgumentError, "request must be provided" if request.nil?
874
1048
 
@@ -946,6 +1120,26 @@ module Google
946
1120
  # @return [::Google::Cloud::AlloyDB::V1beta::ListInstancesResponse]
947
1121
  #
948
1122
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1123
+ #
1124
+ # @example Basic example
1125
+ # require "google/cloud/alloy_db/v1beta"
1126
+ #
1127
+ # # Create a client object. The client can be reused for multiple calls.
1128
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1129
+ #
1130
+ # # Create a request. To set request fields, pass in keyword arguments.
1131
+ # request = Google::Cloud::AlloyDB::V1beta::ListInstancesRequest.new
1132
+ #
1133
+ # # Call the list_instances method.
1134
+ # result = client.list_instances request
1135
+ #
1136
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1137
+ # # over elements, and API calls will be issued to fetch pages as needed.
1138
+ # result.each do |item|
1139
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1beta::Instance.
1140
+ # p item
1141
+ # end
1142
+ #
949
1143
  def list_instances request, options = nil
950
1144
  raise ::ArgumentError, "request must be provided" if request.nil?
951
1145
 
@@ -1011,6 +1205,22 @@ module Google
1011
1205
  # @return [::Google::Cloud::AlloyDB::V1beta::Instance]
1012
1206
  #
1013
1207
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1208
+ #
1209
+ # @example Basic example
1210
+ # require "google/cloud/alloy_db/v1beta"
1211
+ #
1212
+ # # Create a client object. The client can be reused for multiple calls.
1213
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1214
+ #
1215
+ # # Create a request. To set request fields, pass in keyword arguments.
1216
+ # request = Google::Cloud::AlloyDB::V1beta::GetInstanceRequest.new
1217
+ #
1218
+ # # Call the get_instance method.
1219
+ # result = client.get_instance request
1220
+ #
1221
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::Instance.
1222
+ # p result
1223
+ #
1014
1224
  def get_instance request, options = nil
1015
1225
  raise ::ArgumentError, "request must be provided" if request.nil?
1016
1226
 
@@ -1096,6 +1306,29 @@ module Google
1096
1306
  # @return [::Gapic::Operation]
1097
1307
  #
1098
1308
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1309
+ #
1310
+ # @example Basic example
1311
+ # require "google/cloud/alloy_db/v1beta"
1312
+ #
1313
+ # # Create a client object. The client can be reused for multiple calls.
1314
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1315
+ #
1316
+ # # Create a request. To set request fields, pass in keyword arguments.
1317
+ # request = Google::Cloud::AlloyDB::V1beta::CreateInstanceRequest.new
1318
+ #
1319
+ # # Call the create_instance method.
1320
+ # result = client.create_instance request
1321
+ #
1322
+ # # The returned object is of type Gapic::Operation. You can use it to
1323
+ # # check the status of an operation, cancel it, or wait for results.
1324
+ # # Here is how to wait for a response.
1325
+ # result.wait_until_done! timeout: 60
1326
+ # if result.response?
1327
+ # p result.response
1328
+ # else
1329
+ # puts "No response received."
1330
+ # end
1331
+ #
1099
1332
  def create_instance request, options = nil
1100
1333
  raise ::ArgumentError, "request must be provided" if request.nil?
1101
1334
 
@@ -1182,6 +1415,29 @@ module Google
1182
1415
  # @return [::Gapic::Operation]
1183
1416
  #
1184
1417
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1418
+ #
1419
+ # @example Basic example
1420
+ # require "google/cloud/alloy_db/v1beta"
1421
+ #
1422
+ # # Create a client object. The client can be reused for multiple calls.
1423
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1424
+ #
1425
+ # # Create a request. To set request fields, pass in keyword arguments.
1426
+ # request = Google::Cloud::AlloyDB::V1beta::CreateSecondaryInstanceRequest.new
1427
+ #
1428
+ # # Call the create_secondary_instance method.
1429
+ # result = client.create_secondary_instance request
1430
+ #
1431
+ # # The returned object is of type Gapic::Operation. You can use it to
1432
+ # # check the status of an operation, cancel it, or wait for results.
1433
+ # # Here is how to wait for a response.
1434
+ # result.wait_until_done! timeout: 60
1435
+ # if result.response?
1436
+ # p result.response
1437
+ # else
1438
+ # puts "No response received."
1439
+ # end
1440
+ #
1185
1441
  def create_secondary_instance request, options = nil
1186
1442
  raise ::ArgumentError, "request must be provided" if request.nil?
1187
1443
 
@@ -1270,6 +1526,29 @@ module Google
1270
1526
  # @return [::Gapic::Operation]
1271
1527
  #
1272
1528
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1529
+ #
1530
+ # @example Basic example
1531
+ # require "google/cloud/alloy_db/v1beta"
1532
+ #
1533
+ # # Create a client object. The client can be reused for multiple calls.
1534
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1535
+ #
1536
+ # # Create a request. To set request fields, pass in keyword arguments.
1537
+ # request = Google::Cloud::AlloyDB::V1beta::BatchCreateInstancesRequest.new
1538
+ #
1539
+ # # Call the batch_create_instances method.
1540
+ # result = client.batch_create_instances request
1541
+ #
1542
+ # # The returned object is of type Gapic::Operation. You can use it to
1543
+ # # check the status of an operation, cancel it, or wait for results.
1544
+ # # Here is how to wait for a response.
1545
+ # result.wait_until_done! timeout: 60
1546
+ # if result.response?
1547
+ # p result.response
1548
+ # else
1549
+ # puts "No response received."
1550
+ # end
1551
+ #
1273
1552
  def batch_create_instances request, options = nil
1274
1553
  raise ::ArgumentError, "request must be provided" if request.nil?
1275
1554
 
@@ -1360,6 +1639,29 @@ module Google
1360
1639
  # @return [::Gapic::Operation]
1361
1640
  #
1362
1641
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1642
+ #
1643
+ # @example Basic example
1644
+ # require "google/cloud/alloy_db/v1beta"
1645
+ #
1646
+ # # Create a client object. The client can be reused for multiple calls.
1647
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1648
+ #
1649
+ # # Create a request. To set request fields, pass in keyword arguments.
1650
+ # request = Google::Cloud::AlloyDB::V1beta::UpdateInstanceRequest.new
1651
+ #
1652
+ # # Call the update_instance method.
1653
+ # result = client.update_instance request
1654
+ #
1655
+ # # The returned object is of type Gapic::Operation. You can use it to
1656
+ # # check the status of an operation, cancel it, or wait for results.
1657
+ # # Here is how to wait for a response.
1658
+ # result.wait_until_done! timeout: 60
1659
+ # if result.response?
1660
+ # p result.response
1661
+ # else
1662
+ # puts "No response received."
1663
+ # end
1664
+ #
1363
1665
  def update_instance request, options = nil
1364
1666
  raise ::ArgumentError, "request must be provided" if request.nil?
1365
1667
 
@@ -1445,6 +1747,29 @@ module Google
1445
1747
  # @return [::Gapic::Operation]
1446
1748
  #
1447
1749
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1750
+ #
1751
+ # @example Basic example
1752
+ # require "google/cloud/alloy_db/v1beta"
1753
+ #
1754
+ # # Create a client object. The client can be reused for multiple calls.
1755
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1756
+ #
1757
+ # # Create a request. To set request fields, pass in keyword arguments.
1758
+ # request = Google::Cloud::AlloyDB::V1beta::DeleteInstanceRequest.new
1759
+ #
1760
+ # # Call the delete_instance method.
1761
+ # result = client.delete_instance request
1762
+ #
1763
+ # # The returned object is of type Gapic::Operation. You can use it to
1764
+ # # check the status of an operation, cancel it, or wait for results.
1765
+ # # Here is how to wait for a response.
1766
+ # result.wait_until_done! timeout: 60
1767
+ # if result.response?
1768
+ # p result.response
1769
+ # else
1770
+ # puts "No response received."
1771
+ # end
1772
+ #
1448
1773
  def delete_instance request, options = nil
1449
1774
  raise ::ArgumentError, "request must be provided" if request.nil?
1450
1775
 
@@ -1528,6 +1853,29 @@ module Google
1528
1853
  # @return [::Gapic::Operation]
1529
1854
  #
1530
1855
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1856
+ #
1857
+ # @example Basic example
1858
+ # require "google/cloud/alloy_db/v1beta"
1859
+ #
1860
+ # # Create a client object. The client can be reused for multiple calls.
1861
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1862
+ #
1863
+ # # Create a request. To set request fields, pass in keyword arguments.
1864
+ # request = Google::Cloud::AlloyDB::V1beta::FailoverInstanceRequest.new
1865
+ #
1866
+ # # Call the failover_instance method.
1867
+ # result = client.failover_instance request
1868
+ #
1869
+ # # The returned object is of type Gapic::Operation. You can use it to
1870
+ # # check the status of an operation, cancel it, or wait for results.
1871
+ # # Here is how to wait for a response.
1872
+ # result.wait_until_done! timeout: 60
1873
+ # if result.response?
1874
+ # p result.response
1875
+ # else
1876
+ # puts "No response received."
1877
+ # end
1878
+ #
1531
1879
  def failover_instance request, options = nil
1532
1880
  raise ::ArgumentError, "request must be provided" if request.nil?
1533
1881
 
@@ -1613,6 +1961,29 @@ module Google
1613
1961
  # @return [::Gapic::Operation]
1614
1962
  #
1615
1963
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1964
+ #
1965
+ # @example Basic example
1966
+ # require "google/cloud/alloy_db/v1beta"
1967
+ #
1968
+ # # Create a client object. The client can be reused for multiple calls.
1969
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
1970
+ #
1971
+ # # Create a request. To set request fields, pass in keyword arguments.
1972
+ # request = Google::Cloud::AlloyDB::V1beta::InjectFaultRequest.new
1973
+ #
1974
+ # # Call the inject_fault method.
1975
+ # result = client.inject_fault request
1976
+ #
1977
+ # # The returned object is of type Gapic::Operation. You can use it to
1978
+ # # check the status of an operation, cancel it, or wait for results.
1979
+ # # Here is how to wait for a response.
1980
+ # result.wait_until_done! timeout: 60
1981
+ # if result.response?
1982
+ # p result.response
1983
+ # else
1984
+ # puts "No response received."
1985
+ # end
1986
+ #
1616
1987
  def inject_fault request, options = nil
1617
1988
  raise ::ArgumentError, "request must be provided" if request.nil?
1618
1989
 
@@ -1695,6 +2066,29 @@ module Google
1695
2066
  # @return [::Gapic::Operation]
1696
2067
  #
1697
2068
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2069
+ #
2070
+ # @example Basic example
2071
+ # require "google/cloud/alloy_db/v1beta"
2072
+ #
2073
+ # # Create a client object. The client can be reused for multiple calls.
2074
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2075
+ #
2076
+ # # Create a request. To set request fields, pass in keyword arguments.
2077
+ # request = Google::Cloud::AlloyDB::V1beta::RestartInstanceRequest.new
2078
+ #
2079
+ # # Call the restart_instance method.
2080
+ # result = client.restart_instance request
2081
+ #
2082
+ # # The returned object is of type Gapic::Operation. You can use it to
2083
+ # # check the status of an operation, cancel it, or wait for results.
2084
+ # # Here is how to wait for a response.
2085
+ # result.wait_until_done! timeout: 60
2086
+ # if result.response?
2087
+ # p result.response
2088
+ # else
2089
+ # puts "No response received."
2090
+ # end
2091
+ #
1698
2092
  def restart_instance request, options = nil
1699
2093
  raise ::ArgumentError, "request must be provided" if request.nil?
1700
2094
 
@@ -1767,6 +2161,26 @@ module Google
1767
2161
  # @return [::Google::Cloud::AlloyDB::V1beta::ListBackupsResponse]
1768
2162
  #
1769
2163
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2164
+ #
2165
+ # @example Basic example
2166
+ # require "google/cloud/alloy_db/v1beta"
2167
+ #
2168
+ # # Create a client object. The client can be reused for multiple calls.
2169
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2170
+ #
2171
+ # # Create a request. To set request fields, pass in keyword arguments.
2172
+ # request = Google::Cloud::AlloyDB::V1beta::ListBackupsRequest.new
2173
+ #
2174
+ # # Call the list_backups method.
2175
+ # result = client.list_backups request
2176
+ #
2177
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2178
+ # # over elements, and API calls will be issued to fetch pages as needed.
2179
+ # result.each do |item|
2180
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1beta::Backup.
2181
+ # p item
2182
+ # end
2183
+ #
1770
2184
  def list_backups request, options = nil
1771
2185
  raise ::ArgumentError, "request must be provided" if request.nil?
1772
2186
 
@@ -1829,6 +2243,22 @@ module Google
1829
2243
  # @return [::Google::Cloud::AlloyDB::V1beta::Backup]
1830
2244
  #
1831
2245
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2246
+ #
2247
+ # @example Basic example
2248
+ # require "google/cloud/alloy_db/v1beta"
2249
+ #
2250
+ # # Create a client object. The client can be reused for multiple calls.
2251
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2252
+ #
2253
+ # # Create a request. To set request fields, pass in keyword arguments.
2254
+ # request = Google::Cloud::AlloyDB::V1beta::GetBackupRequest.new
2255
+ #
2256
+ # # Call the get_backup method.
2257
+ # result = client.get_backup request
2258
+ #
2259
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::Backup.
2260
+ # p result
2261
+ #
1832
2262
  def get_backup request, options = nil
1833
2263
  raise ::ArgumentError, "request must be provided" if request.nil?
1834
2264
 
@@ -1912,6 +2342,29 @@ module Google
1912
2342
  # @return [::Gapic::Operation]
1913
2343
  #
1914
2344
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2345
+ #
2346
+ # @example Basic example
2347
+ # require "google/cloud/alloy_db/v1beta"
2348
+ #
2349
+ # # Create a client object. The client can be reused for multiple calls.
2350
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2351
+ #
2352
+ # # Create a request. To set request fields, pass in keyword arguments.
2353
+ # request = Google::Cloud::AlloyDB::V1beta::CreateBackupRequest.new
2354
+ #
2355
+ # # Call the create_backup method.
2356
+ # result = client.create_backup request
2357
+ #
2358
+ # # The returned object is of type Gapic::Operation. You can use it to
2359
+ # # check the status of an operation, cancel it, or wait for results.
2360
+ # # Here is how to wait for a response.
2361
+ # result.wait_until_done! timeout: 60
2362
+ # if result.response?
2363
+ # p result.response
2364
+ # else
2365
+ # puts "No response received."
2366
+ # end
2367
+ #
1915
2368
  def create_backup request, options = nil
1916
2369
  raise ::ArgumentError, "request must be provided" if request.nil?
1917
2370
 
@@ -2001,6 +2454,29 @@ module Google
2001
2454
  # @return [::Gapic::Operation]
2002
2455
  #
2003
2456
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2457
+ #
2458
+ # @example Basic example
2459
+ # require "google/cloud/alloy_db/v1beta"
2460
+ #
2461
+ # # Create a client object. The client can be reused for multiple calls.
2462
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2463
+ #
2464
+ # # Create a request. To set request fields, pass in keyword arguments.
2465
+ # request = Google::Cloud::AlloyDB::V1beta::UpdateBackupRequest.new
2466
+ #
2467
+ # # Call the update_backup method.
2468
+ # result = client.update_backup request
2469
+ #
2470
+ # # The returned object is of type Gapic::Operation. You can use it to
2471
+ # # check the status of an operation, cancel it, or wait for results.
2472
+ # # Here is how to wait for a response.
2473
+ # result.wait_until_done! timeout: 60
2474
+ # if result.response?
2475
+ # p result.response
2476
+ # else
2477
+ # puts "No response received."
2478
+ # end
2479
+ #
2004
2480
  def update_backup request, options = nil
2005
2481
  raise ::ArgumentError, "request must be provided" if request.nil?
2006
2482
 
@@ -2086,6 +2562,29 @@ module Google
2086
2562
  # @return [::Gapic::Operation]
2087
2563
  #
2088
2564
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2565
+ #
2566
+ # @example Basic example
2567
+ # require "google/cloud/alloy_db/v1beta"
2568
+ #
2569
+ # # Create a client object. The client can be reused for multiple calls.
2570
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2571
+ #
2572
+ # # Create a request. To set request fields, pass in keyword arguments.
2573
+ # request = Google::Cloud::AlloyDB::V1beta::DeleteBackupRequest.new
2574
+ #
2575
+ # # Call the delete_backup method.
2576
+ # result = client.delete_backup request
2577
+ #
2578
+ # # The returned object is of type Gapic::Operation. You can use it to
2579
+ # # check the status of an operation, cancel it, or wait for results.
2580
+ # # Here is how to wait for a response.
2581
+ # result.wait_until_done! timeout: 60
2582
+ # if result.response?
2583
+ # p result.response
2584
+ # else
2585
+ # puts "No response received."
2586
+ # end
2587
+ #
2089
2588
  def delete_backup request, options = nil
2090
2589
  raise ::ArgumentError, "request must be provided" if request.nil?
2091
2590
 
@@ -2160,6 +2659,26 @@ module Google
2160
2659
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag>]
2161
2660
  #
2162
2661
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2662
+ #
2663
+ # @example Basic example
2664
+ # require "google/cloud/alloy_db/v1beta"
2665
+ #
2666
+ # # Create a client object. The client can be reused for multiple calls.
2667
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2668
+ #
2669
+ # # Create a request. To set request fields, pass in keyword arguments.
2670
+ # request = Google::Cloud::AlloyDB::V1beta::ListSupportedDatabaseFlagsRequest.new
2671
+ #
2672
+ # # Call the list_supported_database_flags method.
2673
+ # result = client.list_supported_database_flags request
2674
+ #
2675
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2676
+ # # over elements, and API calls will be issued to fetch pages as needed.
2677
+ # result.each do |item|
2678
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag.
2679
+ # p item
2680
+ # end
2681
+ #
2163
2682
  def list_supported_database_flags request, options = nil
2164
2683
  raise ::ArgumentError, "request must be provided" if request.nil?
2165
2684
 
@@ -2198,10 +2717,10 @@ module Google
2198
2717
 
2199
2718
  ##
2200
2719
  # Generate a client certificate signed by a Cluster CA.
2201
- # The sole purpose of this endpoint is to support the Auth Proxy client and
2202
- # the endpoint's behavior is subject to change without notice, so do not rely
2203
- # on its behavior remaining constant. Future changes will not break the Auth
2204
- # Proxy client.
2720
+ # The sole purpose of this endpoint is to support AlloyDB connectors and the
2721
+ # Auth Proxy client. The endpoint's behavior is subject to change without
2722
+ # notice, so do not rely on its behavior remaining constant. Future changes
2723
+ # will not break AlloyDB connectors or the Auth Proxy client.
2205
2724
  #
2206
2725
  # @overload generate_client_certificate(request, options = nil)
2207
2726
  # Pass arguments to `generate_client_certificate` via a request object, either of type
@@ -2213,7 +2732,7 @@ module Google
2213
2732
  # @param options [::Gapic::CallOptions, ::Hash]
2214
2733
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2215
2734
  #
2216
- # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil)
2735
+ # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil, use_metadata_exchange: nil)
2217
2736
  # Pass arguments to `generate_client_certificate` via keyword arguments. Note that at
2218
2737
  # least one keyword argument is required. To specify no parameters, or to keep all
2219
2738
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2245,6 +2764,10 @@ module Google
2245
2764
  # default duration.
2246
2765
  # @param public_key [::String]
2247
2766
  # Optional. The public key from the client.
2767
+ # @param use_metadata_exchange [::Boolean]
2768
+ # Optional. An optional hint to the endpoint to generate a client
2769
+ # ceritificate that can be used by AlloyDB connectors to exchange additional
2770
+ # metadata with the server after TLS handshake.
2248
2771
  # @yield [result, operation] Access the result along with the TransportOperation object
2249
2772
  # @yieldparam result [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
2250
2773
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2252,6 +2775,22 @@ module Google
2252
2775
  # @return [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
2253
2776
  #
2254
2777
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2778
+ #
2779
+ # @example Basic example
2780
+ # require "google/cloud/alloy_db/v1beta"
2781
+ #
2782
+ # # Create a client object. The client can be reused for multiple calls.
2783
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2784
+ #
2785
+ # # Create a request. To set request fields, pass in keyword arguments.
2786
+ # request = Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateRequest.new
2787
+ #
2788
+ # # Call the generate_client_certificate method.
2789
+ # result = client.generate_client_certificate request
2790
+ #
2791
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse.
2792
+ # p result
2793
+ #
2255
2794
  def generate_client_certificate request, options = nil
2256
2795
  raise ::ArgumentError, "request must be provided" if request.nil?
2257
2796
 
@@ -2329,6 +2868,22 @@ module Google
2329
2868
  # @return [::Google::Cloud::AlloyDB::V1beta::ConnectionInfo]
2330
2869
  #
2331
2870
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2871
+ #
2872
+ # @example Basic example
2873
+ # require "google/cloud/alloy_db/v1beta"
2874
+ #
2875
+ # # Create a client object. The client can be reused for multiple calls.
2876
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2877
+ #
2878
+ # # Create a request. To set request fields, pass in keyword arguments.
2879
+ # request = Google::Cloud::AlloyDB::V1beta::GetConnectionInfoRequest.new
2880
+ #
2881
+ # # Call the get_connection_info method.
2882
+ # result = client.get_connection_info request
2883
+ #
2884
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::ConnectionInfo.
2885
+ # p result
2886
+ #
2332
2887
  def get_connection_info request, options = nil
2333
2888
  raise ::ArgumentError, "request must be provided" if request.nil?
2334
2889
 
@@ -2400,6 +2955,26 @@ module Google
2400
2955
  # @return [::Google::Cloud::AlloyDB::V1beta::ListUsersResponse]
2401
2956
  #
2402
2957
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2958
+ #
2959
+ # @example Basic example
2960
+ # require "google/cloud/alloy_db/v1beta"
2961
+ #
2962
+ # # Create a client object. The client can be reused for multiple calls.
2963
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
2964
+ #
2965
+ # # Create a request. To set request fields, pass in keyword arguments.
2966
+ # request = Google::Cloud::AlloyDB::V1beta::ListUsersRequest.new
2967
+ #
2968
+ # # Call the list_users method.
2969
+ # result = client.list_users request
2970
+ #
2971
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2972
+ # # over elements, and API calls will be issued to fetch pages as needed.
2973
+ # result.each do |item|
2974
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1beta::User.
2975
+ # p item
2976
+ # end
2977
+ #
2403
2978
  def list_users request, options = nil
2404
2979
  raise ::ArgumentError, "request must be provided" if request.nil?
2405
2980
 
@@ -2463,6 +3038,22 @@ module Google
2463
3038
  # @return [::Google::Cloud::AlloyDB::V1beta::User]
2464
3039
  #
2465
3040
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3041
+ #
3042
+ # @example Basic example
3043
+ # require "google/cloud/alloy_db/v1beta"
3044
+ #
3045
+ # # Create a client object. The client can be reused for multiple calls.
3046
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
3047
+ #
3048
+ # # Create a request. To set request fields, pass in keyword arguments.
3049
+ # request = Google::Cloud::AlloyDB::V1beta::GetUserRequest.new
3050
+ #
3051
+ # # Call the get_user method.
3052
+ # result = client.get_user request
3053
+ #
3054
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
3055
+ # p result
3056
+ #
2466
3057
  def get_user request, options = nil
2467
3058
  raise ::ArgumentError, "request must be provided" if request.nil?
2468
3059
 
@@ -2546,6 +3137,22 @@ module Google
2546
3137
  # @return [::Google::Cloud::AlloyDB::V1beta::User]
2547
3138
  #
2548
3139
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3140
+ #
3141
+ # @example Basic example
3142
+ # require "google/cloud/alloy_db/v1beta"
3143
+ #
3144
+ # # Create a client object. The client can be reused for multiple calls.
3145
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
3146
+ #
3147
+ # # Create a request. To set request fields, pass in keyword arguments.
3148
+ # request = Google::Cloud::AlloyDB::V1beta::CreateUserRequest.new
3149
+ #
3150
+ # # Call the create_user method.
3151
+ # result = client.create_user request
3152
+ #
3153
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
3154
+ # p result
3155
+ #
2549
3156
  def create_user request, options = nil
2550
3157
  raise ::ArgumentError, "request must be provided" if request.nil?
2551
3158
 
@@ -2633,6 +3240,22 @@ module Google
2633
3240
  # @return [::Google::Cloud::AlloyDB::V1beta::User]
2634
3241
  #
2635
3242
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3243
+ #
3244
+ # @example Basic example
3245
+ # require "google/cloud/alloy_db/v1beta"
3246
+ #
3247
+ # # Create a client object. The client can be reused for multiple calls.
3248
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
3249
+ #
3250
+ # # Create a request. To set request fields, pass in keyword arguments.
3251
+ # request = Google::Cloud::AlloyDB::V1beta::UpdateUserRequest.new
3252
+ #
3253
+ # # Call the update_user method.
3254
+ # result = client.update_user request
3255
+ #
3256
+ # # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
3257
+ # p result
3258
+ #
2636
3259
  def update_user request, options = nil
2637
3260
  raise ::ArgumentError, "request must be provided" if request.nil?
2638
3261
 
@@ -2713,6 +3336,22 @@ module Google
2713
3336
  # @return [::Google::Protobuf::Empty]
2714
3337
  #
2715
3338
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3339
+ #
3340
+ # @example Basic example
3341
+ # require "google/cloud/alloy_db/v1beta"
3342
+ #
3343
+ # # Create a client object. The client can be reused for multiple calls.
3344
+ # client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
3345
+ #
3346
+ # # Create a request. To set request fields, pass in keyword arguments.
3347
+ # request = Google::Cloud::AlloyDB::V1beta::DeleteUserRequest.new
3348
+ #
3349
+ # # Call the delete_user method.
3350
+ # result = client.delete_user request
3351
+ #
3352
+ # # The returned object is of type Google::Protobuf::Empty.
3353
+ # p result
3354
+ #
2716
3355
  def delete_user request, options = nil
2717
3356
  raise ::ArgumentError, "request must be provided" if request.nil?
2718
3357