google-cloud-bigtable-admin-v2 0.7.0 → 0.7.1

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