google-cloud-bigtable-admin-v2 0.6.1 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -210,6 +210,7 @@ module Google
210
210
 
211
211
  @operations_client = Operations.new do |config|
212
212
  config.credentials = credentials
213
+ config.quota_project = @quota_project_id
213
214
  config.endpoint = @config.endpoint
214
215
  end
215
216
 
@@ -286,6 +287,21 @@ module Google
286
287
  #
287
288
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
288
289
  #
290
+ # @example Basic example
291
+ # require "google/cloud/bigtable/admin/v2"
292
+ #
293
+ # # Create a client object. The client can be reused for multiple calls.
294
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
295
+ #
296
+ # # Create a request. To set request fields, pass in keyword arguments.
297
+ # request = Google::Cloud::Bigtable::Admin::V2::CreateTableRequest.new
298
+ #
299
+ # # Call the create_table method.
300
+ # result = client.create_table request
301
+ #
302
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Table.
303
+ # p result
304
+ #
289
305
  def create_table request, options = nil
290
306
  raise ::ArgumentError, "request must be provided" if request.nil?
291
307
 
@@ -303,9 +319,11 @@ module Google
303
319
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
304
320
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
305
321
 
306
- header_params = {
307
- "parent" => request.parent
308
- }
322
+ header_params = {}
323
+ if request.parent
324
+ header_params["parent"] = request.parent
325
+ end
326
+
309
327
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
310
328
  metadata[:"x-goog-request-params"] ||= request_params_header
311
329
 
@@ -370,6 +388,28 @@ module Google
370
388
  #
371
389
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
372
390
  #
391
+ # @example Basic example
392
+ # require "google/cloud/bigtable/admin/v2"
393
+ #
394
+ # # Create a client object. The client can be reused for multiple calls.
395
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
396
+ #
397
+ # # Create a request. To set request fields, pass in keyword arguments.
398
+ # request = Google::Cloud::Bigtable::Admin::V2::CreateTableFromSnapshotRequest.new
399
+ #
400
+ # # Call the create_table_from_snapshot method.
401
+ # result = client.create_table_from_snapshot request
402
+ #
403
+ # # The returned object is of type Gapic::Operation. You can use this
404
+ # # object to check the status of an operation, cancel it, or wait
405
+ # # for results. Here is how to block until completion:
406
+ # result.wait_until_done! timeout: 60
407
+ # if result.response?
408
+ # p result.response
409
+ # else
410
+ # puts "Error!"
411
+ # end
412
+ #
373
413
  def create_table_from_snapshot request, options = nil
374
414
  raise ::ArgumentError, "request must be provided" if request.nil?
375
415
 
@@ -387,9 +427,11 @@ module Google
387
427
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
388
428
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
389
429
 
390
- header_params = {
391
- "parent" => request.parent
392
- }
430
+ header_params = {}
431
+ if request.parent
432
+ header_params["parent"] = request.parent
433
+ end
434
+
393
435
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
394
436
  metadata[:"x-goog-request-params"] ||= request_params_header
395
437
 
@@ -455,6 +497,27 @@ module Google
455
497
  #
456
498
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
457
499
  #
500
+ # @example Basic example
501
+ # require "google/cloud/bigtable/admin/v2"
502
+ #
503
+ # # Create a client object. The client can be reused for multiple calls.
504
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
505
+ #
506
+ # # Create a request. To set request fields, pass in keyword arguments.
507
+ # request = Google::Cloud::Bigtable::Admin::V2::ListTablesRequest.new
508
+ #
509
+ # # Call the list_tables method.
510
+ # result = client.list_tables request
511
+ #
512
+ # # The returned object is of type Gapic::PagedEnumerable. You can
513
+ # # iterate over all elements by calling #each, and the enumerable
514
+ # # will lazily make API calls to fetch subsequent pages. Other
515
+ # # methods are also available for managing paging directly.
516
+ # result.each do |response|
517
+ # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Table.
518
+ # p response
519
+ # end
520
+ #
458
521
  def list_tables request, options = nil
459
522
  raise ::ArgumentError, "request must be provided" if request.nil?
460
523
 
@@ -472,9 +535,11 @@ module Google
472
535
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
473
536
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
474
537
 
475
- header_params = {
476
- "parent" => request.parent
477
- }
538
+ header_params = {}
539
+ if request.parent
540
+ header_params["parent"] = request.parent
541
+ end
542
+
478
543
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
479
544
  metadata[:"x-goog-request-params"] ||= request_params_header
480
545
 
@@ -529,6 +594,21 @@ module Google
529
594
  #
530
595
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
531
596
  #
597
+ # @example Basic example
598
+ # require "google/cloud/bigtable/admin/v2"
599
+ #
600
+ # # Create a client object. The client can be reused for multiple calls.
601
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
602
+ #
603
+ # # Create a request. To set request fields, pass in keyword arguments.
604
+ # request = Google::Cloud::Bigtable::Admin::V2::GetTableRequest.new
605
+ #
606
+ # # Call the get_table method.
607
+ # result = client.get_table request
608
+ #
609
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Table.
610
+ # p result
611
+ #
532
612
  def get_table request, options = nil
533
613
  raise ::ArgumentError, "request must be provided" if request.nil?
534
614
 
@@ -546,9 +626,11 @@ module Google
546
626
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
547
627
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
548
628
 
549
- header_params = {
550
- "name" => request.name
551
- }
629
+ header_params = {}
630
+ if request.name
631
+ header_params["name"] = request.name
632
+ end
633
+
552
634
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
553
635
  metadata[:"x-goog-request-params"] ||= request_params_header
554
636
 
@@ -599,6 +681,21 @@ module Google
599
681
  #
600
682
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
601
683
  #
684
+ # @example Basic example
685
+ # require "google/cloud/bigtable/admin/v2"
686
+ #
687
+ # # Create a client object. The client can be reused for multiple calls.
688
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
689
+ #
690
+ # # Create a request. To set request fields, pass in keyword arguments.
691
+ # request = Google::Cloud::Bigtable::Admin::V2::DeleteTableRequest.new
692
+ #
693
+ # # Call the delete_table method.
694
+ # result = client.delete_table request
695
+ #
696
+ # # The returned object is of type Google::Protobuf::Empty.
697
+ # p result
698
+ #
602
699
  def delete_table request, options = nil
603
700
  raise ::ArgumentError, "request must be provided" if request.nil?
604
701
 
@@ -616,9 +713,11 @@ module Google
616
713
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
617
714
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
618
715
 
619
- header_params = {
620
- "name" => request.name
621
- }
716
+ header_params = {}
717
+ if request.name
718
+ header_params["name"] = request.name
719
+ end
720
+
622
721
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
623
722
  metadata[:"x-goog-request-params"] ||= request_params_header
624
723
 
@@ -677,6 +776,21 @@ module Google
677
776
  #
678
777
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
679
778
  #
779
+ # @example Basic example
780
+ # require "google/cloud/bigtable/admin/v2"
781
+ #
782
+ # # Create a client object. The client can be reused for multiple calls.
783
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
784
+ #
785
+ # # Create a request. To set request fields, pass in keyword arguments.
786
+ # request = Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest.new
787
+ #
788
+ # # Call the modify_column_families method.
789
+ # result = client.modify_column_families request
790
+ #
791
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Table.
792
+ # p result
793
+ #
680
794
  def modify_column_families request, options = nil
681
795
  raise ::ArgumentError, "request must be provided" if request.nil?
682
796
 
@@ -694,9 +808,11 @@ module Google
694
808
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
695
809
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
696
810
 
697
- header_params = {
698
- "name" => request.name
699
- }
811
+ header_params = {}
812
+ if request.name
813
+ header_params["name"] = request.name
814
+ end
815
+
700
816
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
701
817
  metadata[:"x-goog-request-params"] ||= request_params_header
702
818
 
@@ -754,6 +870,21 @@ module Google
754
870
  #
755
871
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
756
872
  #
873
+ # @example Basic example
874
+ # require "google/cloud/bigtable/admin/v2"
875
+ #
876
+ # # Create a client object. The client can be reused for multiple calls.
877
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
878
+ #
879
+ # # Create a request. To set request fields, pass in keyword arguments.
880
+ # request = Google::Cloud::Bigtable::Admin::V2::DropRowRangeRequest.new
881
+ #
882
+ # # Call the drop_row_range method.
883
+ # result = client.drop_row_range request
884
+ #
885
+ # # The returned object is of type Google::Protobuf::Empty.
886
+ # p result
887
+ #
757
888
  def drop_row_range request, options = nil
758
889
  raise ::ArgumentError, "request must be provided" if request.nil?
759
890
 
@@ -771,9 +902,11 @@ module Google
771
902
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
772
903
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
773
904
 
774
- header_params = {
775
- "name" => request.name
776
- }
905
+ header_params = {}
906
+ if request.name
907
+ header_params["name"] = request.name
908
+ end
909
+
777
910
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
778
911
  metadata[:"x-goog-request-params"] ||= request_params_header
779
912
 
@@ -827,6 +960,21 @@ module Google
827
960
  #
828
961
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
829
962
  #
963
+ # @example Basic example
964
+ # require "google/cloud/bigtable/admin/v2"
965
+ #
966
+ # # Create a client object. The client can be reused for multiple calls.
967
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
968
+ #
969
+ # # Create a request. To set request fields, pass in keyword arguments.
970
+ # request = Google::Cloud::Bigtable::Admin::V2::GenerateConsistencyTokenRequest.new
971
+ #
972
+ # # Call the generate_consistency_token method.
973
+ # result = client.generate_consistency_token request
974
+ #
975
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::GenerateConsistencyTokenResponse.
976
+ # p result
977
+ #
830
978
  def generate_consistency_token request, options = nil
831
979
  raise ::ArgumentError, "request must be provided" if request.nil?
832
980
 
@@ -844,9 +992,11 @@ module Google
844
992
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
845
993
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
846
994
 
847
- header_params = {
848
- "name" => request.name
849
- }
995
+ header_params = {}
996
+ if request.name
997
+ header_params["name"] = request.name
998
+ end
999
+
850
1000
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
851
1001
  metadata[:"x-goog-request-params"] ||= request_params_header
852
1002
 
@@ -901,6 +1051,21 @@ module Google
901
1051
  #
902
1052
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
903
1053
  #
1054
+ # @example Basic example
1055
+ # require "google/cloud/bigtable/admin/v2"
1056
+ #
1057
+ # # Create a client object. The client can be reused for multiple calls.
1058
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1059
+ #
1060
+ # # Create a request. To set request fields, pass in keyword arguments.
1061
+ # request = Google::Cloud::Bigtable::Admin::V2::CheckConsistencyRequest.new
1062
+ #
1063
+ # # Call the check_consistency method.
1064
+ # result = client.check_consistency request
1065
+ #
1066
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::CheckConsistencyResponse.
1067
+ # p result
1068
+ #
904
1069
  def check_consistency request, options = nil
905
1070
  raise ::ArgumentError, "request must be provided" if request.nil?
906
1071
 
@@ -918,9 +1083,11 @@ module Google
918
1083
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
919
1084
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
920
1085
 
921
- header_params = {
922
- "name" => request.name
923
- }
1086
+ header_params = {}
1087
+ if request.name
1088
+ header_params["name"] = request.name
1089
+ end
1090
+
924
1091
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
925
1092
  metadata[:"x-goog-request-params"] ||= request_params_header
926
1093
 
@@ -994,6 +1161,28 @@ module Google
994
1161
  #
995
1162
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
996
1163
  #
1164
+ # @example Basic example
1165
+ # require "google/cloud/bigtable/admin/v2"
1166
+ #
1167
+ # # Create a client object. The client can be reused for multiple calls.
1168
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1169
+ #
1170
+ # # Create a request. To set request fields, pass in keyword arguments.
1171
+ # request = Google::Cloud::Bigtable::Admin::V2::SnapshotTableRequest.new
1172
+ #
1173
+ # # Call the snapshot_table method.
1174
+ # result = client.snapshot_table request
1175
+ #
1176
+ # # The returned object is of type Gapic::Operation. You can use this
1177
+ # # object to check the status of an operation, cancel it, or wait
1178
+ # # for results. Here is how to block until completion:
1179
+ # result.wait_until_done! timeout: 60
1180
+ # if result.response?
1181
+ # p result.response
1182
+ # else
1183
+ # puts "Error!"
1184
+ # end
1185
+ #
997
1186
  def snapshot_table request, options = nil
998
1187
  raise ::ArgumentError, "request must be provided" if request.nil?
999
1188
 
@@ -1011,9 +1200,11 @@ module Google
1011
1200
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1012
1201
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1013
1202
 
1014
- header_params = {
1015
- "name" => request.name
1016
- }
1203
+ header_params = {}
1204
+ if request.name
1205
+ header_params["name"] = request.name
1206
+ end
1207
+
1017
1208
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1018
1209
  metadata[:"x-goog-request-params"] ||= request_params_header
1019
1210
 
@@ -1071,6 +1262,21 @@ module Google
1071
1262
  #
1072
1263
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1073
1264
  #
1265
+ # @example Basic example
1266
+ # require "google/cloud/bigtable/admin/v2"
1267
+ #
1268
+ # # Create a client object. The client can be reused for multiple calls.
1269
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1270
+ #
1271
+ # # Create a request. To set request fields, pass in keyword arguments.
1272
+ # request = Google::Cloud::Bigtable::Admin::V2::GetSnapshotRequest.new
1273
+ #
1274
+ # # Call the get_snapshot method.
1275
+ # result = client.get_snapshot request
1276
+ #
1277
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Snapshot.
1278
+ # p result
1279
+ #
1074
1280
  def get_snapshot request, options = nil
1075
1281
  raise ::ArgumentError, "request must be provided" if request.nil?
1076
1282
 
@@ -1088,9 +1294,11 @@ module Google
1088
1294
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1089
1295
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1090
1296
 
1091
- header_params = {
1092
- "name" => request.name
1093
- }
1297
+ header_params = {}
1298
+ if request.name
1299
+ header_params["name"] = request.name
1300
+ end
1301
+
1094
1302
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1095
1303
  metadata[:"x-goog-request-params"] ||= request_params_header
1096
1304
 
@@ -1154,6 +1362,27 @@ module Google
1154
1362
  #
1155
1363
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1156
1364
  #
1365
+ # @example Basic example
1366
+ # require "google/cloud/bigtable/admin/v2"
1367
+ #
1368
+ # # Create a client object. The client can be reused for multiple calls.
1369
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1370
+ #
1371
+ # # Create a request. To set request fields, pass in keyword arguments.
1372
+ # request = Google::Cloud::Bigtable::Admin::V2::ListSnapshotsRequest.new
1373
+ #
1374
+ # # Call the list_snapshots method.
1375
+ # result = client.list_snapshots request
1376
+ #
1377
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1378
+ # # iterate over all elements by calling #each, and the enumerable
1379
+ # # will lazily make API calls to fetch subsequent pages. Other
1380
+ # # methods are also available for managing paging directly.
1381
+ # result.each do |response|
1382
+ # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Snapshot.
1383
+ # p response
1384
+ # end
1385
+ #
1157
1386
  def list_snapshots request, options = nil
1158
1387
  raise ::ArgumentError, "request must be provided" if request.nil?
1159
1388
 
@@ -1171,9 +1400,11 @@ module Google
1171
1400
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1172
1401
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1173
1402
 
1174
- header_params = {
1175
- "parent" => request.parent
1176
- }
1403
+ header_params = {}
1404
+ if request.parent
1405
+ header_params["parent"] = request.parent
1406
+ end
1407
+
1177
1408
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1178
1409
  metadata[:"x-goog-request-params"] ||= request_params_header
1179
1410
 
@@ -1231,6 +1462,21 @@ module Google
1231
1462
  #
1232
1463
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1233
1464
  #
1465
+ # @example Basic example
1466
+ # require "google/cloud/bigtable/admin/v2"
1467
+ #
1468
+ # # Create a client object. The client can be reused for multiple calls.
1469
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1470
+ #
1471
+ # # Create a request. To set request fields, pass in keyword arguments.
1472
+ # request = Google::Cloud::Bigtable::Admin::V2::DeleteSnapshotRequest.new
1473
+ #
1474
+ # # Call the delete_snapshot method.
1475
+ # result = client.delete_snapshot request
1476
+ #
1477
+ # # The returned object is of type Google::Protobuf::Empty.
1478
+ # p result
1479
+ #
1234
1480
  def delete_snapshot request, options = nil
1235
1481
  raise ::ArgumentError, "request must be provided" if request.nil?
1236
1482
 
@@ -1248,9 +1494,11 @@ module Google
1248
1494
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1249
1495
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1250
1496
 
1251
- header_params = {
1252
- "name" => request.name
1253
- }
1497
+ header_params = {}
1498
+ if request.name
1499
+ header_params["name"] = request.name
1500
+ end
1501
+
1254
1502
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1255
1503
  metadata[:"x-goog-request-params"] ||= request_params_header
1256
1504
 
@@ -1317,6 +1565,28 @@ module Google
1317
1565
  #
1318
1566
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1319
1567
  #
1568
+ # @example Basic example
1569
+ # require "google/cloud/bigtable/admin/v2"
1570
+ #
1571
+ # # Create a client object. The client can be reused for multiple calls.
1572
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1573
+ #
1574
+ # # Create a request. To set request fields, pass in keyword arguments.
1575
+ # request = Google::Cloud::Bigtable::Admin::V2::CreateBackupRequest.new
1576
+ #
1577
+ # # Call the create_backup method.
1578
+ # result = client.create_backup request
1579
+ #
1580
+ # # The returned object is of type Gapic::Operation. You can use this
1581
+ # # object to check the status of an operation, cancel it, or wait
1582
+ # # for results. Here is how to block until completion:
1583
+ # result.wait_until_done! timeout: 60
1584
+ # if result.response?
1585
+ # p result.response
1586
+ # else
1587
+ # puts "Error!"
1588
+ # end
1589
+ #
1320
1590
  def create_backup request, options = nil
1321
1591
  raise ::ArgumentError, "request must be provided" if request.nil?
1322
1592
 
@@ -1334,9 +1604,11 @@ module Google
1334
1604
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1335
1605
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1336
1606
 
1337
- header_params = {
1338
- "parent" => request.parent
1339
- }
1607
+ header_params = {}
1608
+ if request.parent
1609
+ header_params["parent"] = request.parent
1610
+ end
1611
+
1340
1612
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1341
1613
  metadata[:"x-goog-request-params"] ||= request_params_header
1342
1614
 
@@ -1388,6 +1660,21 @@ module Google
1388
1660
  #
1389
1661
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1390
1662
  #
1663
+ # @example Basic example
1664
+ # require "google/cloud/bigtable/admin/v2"
1665
+ #
1666
+ # # Create a client object. The client can be reused for multiple calls.
1667
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1668
+ #
1669
+ # # Create a request. To set request fields, pass in keyword arguments.
1670
+ # request = Google::Cloud::Bigtable::Admin::V2::GetBackupRequest.new
1671
+ #
1672
+ # # Call the get_backup method.
1673
+ # result = client.get_backup request
1674
+ #
1675
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Backup.
1676
+ # p result
1677
+ #
1391
1678
  def get_backup request, options = nil
1392
1679
  raise ::ArgumentError, "request must be provided" if request.nil?
1393
1680
 
@@ -1405,9 +1692,11 @@ module Google
1405
1692
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1406
1693
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1407
1694
 
1408
- header_params = {
1409
- "name" => request.name
1410
- }
1695
+ header_params = {}
1696
+ if request.name
1697
+ header_params["name"] = request.name
1698
+ end
1699
+
1411
1700
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1412
1701
  metadata[:"x-goog-request-params"] ||= request_params_header
1413
1702
 
@@ -1465,6 +1754,21 @@ module Google
1465
1754
  #
1466
1755
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1467
1756
  #
1757
+ # @example Basic example
1758
+ # require "google/cloud/bigtable/admin/v2"
1759
+ #
1760
+ # # Create a client object. The client can be reused for multiple calls.
1761
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1762
+ #
1763
+ # # Create a request. To set request fields, pass in keyword arguments.
1764
+ # request = Google::Cloud::Bigtable::Admin::V2::UpdateBackupRequest.new
1765
+ #
1766
+ # # Call the update_backup method.
1767
+ # result = client.update_backup request
1768
+ #
1769
+ # # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Backup.
1770
+ # p result
1771
+ #
1468
1772
  def update_backup request, options = nil
1469
1773
  raise ::ArgumentError, "request must be provided" if request.nil?
1470
1774
 
@@ -1482,9 +1786,11 @@ module Google
1482
1786
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1483
1787
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1484
1788
 
1485
- header_params = {
1486
- "backup.name" => request.backup.name
1487
- }
1789
+ header_params = {}
1790
+ if request.backup&.name
1791
+ header_params["backup.name"] = request.backup.name
1792
+ end
1793
+
1488
1794
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1489
1795
  metadata[:"x-goog-request-params"] ||= request_params_header
1490
1796
 
@@ -1535,6 +1841,21 @@ module Google
1535
1841
  #
1536
1842
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1537
1843
  #
1844
+ # @example Basic example
1845
+ # require "google/cloud/bigtable/admin/v2"
1846
+ #
1847
+ # # Create a client object. The client can be reused for multiple calls.
1848
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
1849
+ #
1850
+ # # Create a request. To set request fields, pass in keyword arguments.
1851
+ # request = Google::Cloud::Bigtable::Admin::V2::DeleteBackupRequest.new
1852
+ #
1853
+ # # Call the delete_backup method.
1854
+ # result = client.delete_backup request
1855
+ #
1856
+ # # The returned object is of type Google::Protobuf::Empty.
1857
+ # p result
1858
+ #
1538
1859
  def delete_backup request, options = nil
1539
1860
  raise ::ArgumentError, "request must be provided" if request.nil?
1540
1861
 
@@ -1552,9 +1873,11 @@ module Google
1552
1873
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1553
1874
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1554
1875
 
1555
- header_params = {
1556
- "name" => request.name
1557
- }
1876
+ header_params = {}
1877
+ if request.name
1878
+ header_params["name"] = request.name
1879
+ end
1880
+
1558
1881
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1559
1882
  metadata[:"x-goog-request-params"] ||= request_params_header
1560
1883
 
@@ -1669,6 +1992,27 @@ module Google
1669
1992
  #
1670
1993
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1671
1994
  #
1995
+ # @example Basic example
1996
+ # require "google/cloud/bigtable/admin/v2"
1997
+ #
1998
+ # # Create a client object. The client can be reused for multiple calls.
1999
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
2000
+ #
2001
+ # # Create a request. To set request fields, pass in keyword arguments.
2002
+ # request = Google::Cloud::Bigtable::Admin::V2::ListBackupsRequest.new
2003
+ #
2004
+ # # Call the list_backups method.
2005
+ # result = client.list_backups request
2006
+ #
2007
+ # # The returned object is of type Gapic::PagedEnumerable. You can
2008
+ # # iterate over all elements by calling #each, and the enumerable
2009
+ # # will lazily make API calls to fetch subsequent pages. Other
2010
+ # # methods are also available for managing paging directly.
2011
+ # result.each do |response|
2012
+ # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Backup.
2013
+ # p response
2014
+ # end
2015
+ #
1672
2016
  def list_backups request, options = nil
1673
2017
  raise ::ArgumentError, "request must be provided" if request.nil?
1674
2018
 
@@ -1686,9 +2030,11 @@ module Google
1686
2030
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1687
2031
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1688
2032
 
1689
- header_params = {
1690
- "parent" => request.parent
1691
- }
2033
+ header_params = {}
2034
+ if request.parent
2035
+ header_params["parent"] = request.parent
2036
+ end
2037
+
1692
2038
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1693
2039
  metadata[:"x-goog-request-params"] ||= request_params_header
1694
2040
 
@@ -1755,6 +2101,28 @@ module Google
1755
2101
  #
1756
2102
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1757
2103
  #
2104
+ # @example Basic example
2105
+ # require "google/cloud/bigtable/admin/v2"
2106
+ #
2107
+ # # Create a client object. The client can be reused for multiple calls.
2108
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
2109
+ #
2110
+ # # Create a request. To set request fields, pass in keyword arguments.
2111
+ # request = Google::Cloud::Bigtable::Admin::V2::RestoreTableRequest.new
2112
+ #
2113
+ # # Call the restore_table method.
2114
+ # result = client.restore_table request
2115
+ #
2116
+ # # The returned object is of type Gapic::Operation. You can use this
2117
+ # # object to check the status of an operation, cancel it, or wait
2118
+ # # for results. Here is how to block until completion:
2119
+ # result.wait_until_done! timeout: 60
2120
+ # if result.response?
2121
+ # p result.response
2122
+ # else
2123
+ # puts "Error!"
2124
+ # end
2125
+ #
1758
2126
  def restore_table request, options = nil
1759
2127
  raise ::ArgumentError, "request must be provided" if request.nil?
1760
2128
 
@@ -1772,9 +2140,11 @@ module Google
1772
2140
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1773
2141
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1774
2142
 
1775
- header_params = {
1776
- "parent" => request.parent
1777
- }
2143
+ header_params = {}
2144
+ if request.parent
2145
+ header_params["parent"] = request.parent
2146
+ end
2147
+
1778
2148
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1779
2149
  metadata[:"x-goog-request-params"] ||= request_params_header
1780
2150
 
@@ -1830,6 +2200,21 @@ module Google
1830
2200
  #
1831
2201
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1832
2202
  #
2203
+ # @example Basic example
2204
+ # require "google/cloud/bigtable/admin/v2"
2205
+ #
2206
+ # # Create a client object. The client can be reused for multiple calls.
2207
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
2208
+ #
2209
+ # # Create a request. To set request fields, pass in keyword arguments.
2210
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
2211
+ #
2212
+ # # Call the get_iam_policy method.
2213
+ # result = client.get_iam_policy request
2214
+ #
2215
+ # # The returned object is of type Google::Iam::V1::Policy.
2216
+ # p result
2217
+ #
1833
2218
  def get_iam_policy request, options = nil
1834
2219
  raise ::ArgumentError, "request must be provided" if request.nil?
1835
2220
 
@@ -1847,9 +2232,11 @@ module Google
1847
2232
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1848
2233
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1849
2234
 
1850
- header_params = {
1851
- "resource" => request.resource
1852
- }
2235
+ header_params = {}
2236
+ if request.resource
2237
+ header_params["resource"] = request.resource
2238
+ end
2239
+
1853
2240
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1854
2241
  metadata[:"x-goog-request-params"] ||= request_params_header
1855
2242
 
@@ -1905,6 +2292,21 @@ module Google
1905
2292
  #
1906
2293
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1907
2294
  #
2295
+ # @example Basic example
2296
+ # require "google/cloud/bigtable/admin/v2"
2297
+ #
2298
+ # # Create a client object. The client can be reused for multiple calls.
2299
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
2300
+ #
2301
+ # # Create a request. To set request fields, pass in keyword arguments.
2302
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
2303
+ #
2304
+ # # Call the set_iam_policy method.
2305
+ # result = client.set_iam_policy request
2306
+ #
2307
+ # # The returned object is of type Google::Iam::V1::Policy.
2308
+ # p result
2309
+ #
1908
2310
  def set_iam_policy request, options = nil
1909
2311
  raise ::ArgumentError, "request must be provided" if request.nil?
1910
2312
 
@@ -1922,9 +2324,11 @@ module Google
1922
2324
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1923
2325
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1924
2326
 
1925
- header_params = {
1926
- "resource" => request.resource
1927
- }
2327
+ header_params = {}
2328
+ if request.resource
2329
+ header_params["resource"] = request.resource
2330
+ end
2331
+
1928
2332
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1929
2333
  metadata[:"x-goog-request-params"] ||= request_params_header
1930
2334
 
@@ -1979,6 +2383,21 @@ module Google
1979
2383
  #
1980
2384
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1981
2385
  #
2386
+ # @example Basic example
2387
+ # require "google/cloud/bigtable/admin/v2"
2388
+ #
2389
+ # # Create a client object. The client can be reused for multiple calls.
2390
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
2391
+ #
2392
+ # # Create a request. To set request fields, pass in keyword arguments.
2393
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
2394
+ #
2395
+ # # Call the test_iam_permissions method.
2396
+ # result = client.test_iam_permissions request
2397
+ #
2398
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
2399
+ # p result
2400
+ #
1982
2401
  def test_iam_permissions request, options = nil
1983
2402
  raise ::ArgumentError, "request must be provided" if request.nil?
1984
2403
 
@@ -1996,9 +2415,11 @@ module Google
1996
2415
  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
1997
2416
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1998
2417
 
1999
- header_params = {
2000
- "resource" => request.resource
2001
- }
2418
+ header_params = {}
2419
+ if request.resource
2420
+ header_params["resource"] = request.resource
2421
+ end
2422
+
2002
2423
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2003
2424
  metadata[:"x-goog-request-params"] ||= request_params_header
2004
2425