Class: Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb

Overview

REST service stub for the DatabaseAdmin service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Instance Method Summary collapse

Instance Method Details

#copy_backup(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the copy_backup REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 532

def copy_backup request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_copy_backup_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "copy_backup",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#create_backup(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the create_backup REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 492

def create_backup request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_backup_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "create_backup",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#create_backup_schedule(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule

Baseline implementation for the create_backup_schedule REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 892

def create_backup_schedule request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_backup_schedule_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "create_backup_schedule",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#create_database(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the create_database REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 132

def create_database request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_database_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "create_database",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#delete_backup(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty

Baseline implementation for the delete_backup REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 652

def delete_backup request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_delete_backup_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "delete_backup",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#delete_backup_schedule(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty

Baseline implementation for the delete_backup_schedule REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 1012

def delete_backup_schedule request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_delete_backup_schedule_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "delete_backup_schedule",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#drop_database(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty

Baseline implementation for the drop_database REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 292

def drop_database request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_drop_database_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "drop_database",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


65
66
67
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 65

def endpoint
  @client_stub.endpoint
end

#get_backup(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::Backup

Baseline implementation for the get_backup REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 572

def get_backup request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_backup_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "get_backup",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::Backup.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#get_backup_schedule(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule

Baseline implementation for the get_backup_schedule REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 932

def get_backup_schedule request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_backup_schedule_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "get_backup_schedule",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#get_database(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::Database

Baseline implementation for the get_database REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 172

def get_database request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_database_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "get_database",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::Database.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#get_database_ddl(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse

Baseline implementation for the get_database_ddl REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 332

def get_database_ddl request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_database_ddl_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "get_database_ddl",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#get_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy

Baseline implementation for the get_iam_policy REST call

Parameters:

  • request_pb (::Google::Iam::V1::GetIamPolicyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 412

def get_iam_policy request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_iam_policy_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "get_iam_policy",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_backup_operations(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse

Baseline implementation for the list_backup_operations REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 812

def list_backup_operations request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_backup_operations_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_backup_operations",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_backup_schedules(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesResponse

Baseline implementation for the list_backup_schedules REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 1052

def list_backup_schedules request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_backup_schedules_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_backup_schedules",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupSchedulesResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_backups(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse

Baseline implementation for the list_backups REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 692

def list_backups request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_backups_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_backups",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_database_operations(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse

Baseline implementation for the list_database_operations REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 772

def list_database_operations request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_database_operations_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_database_operations",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_database_roles(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse

Baseline implementation for the list_database_roles REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 852

def list_database_roles request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_database_roles_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_database_roles",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#list_databases(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse

Baseline implementation for the list_databases REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 92

def list_databases request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_databases_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "list_databases",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#logger(stub: false) ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


74
75
76
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 74

def logger stub: false
  stub ? @client_stub.stub_logger : @client_stub.logger
end

#restore_database(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the restore_database REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 732

def restore_database request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_restore_database_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "restore_database",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#set_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters:

  • request_pb (::Google::Iam::V1::SetIamPolicyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 372

def set_iam_policy request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_set_iam_policy_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "set_iam_policy",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#test_iam_permissions(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters:

  • request_pb (::Google::Iam::V1::TestIamPermissionsRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 452

def test_iam_permissions request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_test_iam_permissions_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "test_iam_permissions",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Iam::V1::TestIamPermissionsResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


56
57
58
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 56

def universe_domain
  @client_stub.universe_domain
end

#update_backup(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::Backup

Baseline implementation for the update_backup REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 612

def update_backup request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_backup_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "update_backup",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::Backup.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#update_backup_schedule(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule

Baseline implementation for the update_backup_schedule REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 972

def update_backup_schedule request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_backup_schedule_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "update_backup_schedule",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#update_database(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the update_database REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 212

def update_database request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_database_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "update_database",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#update_database_ddl(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the update_database_ddl REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb', line 252

def update_database_ddl request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_database_ddl_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri: uri,
    body: body || "",
    params: query_string_params,
    method_name: "update_database_ddl",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end