Class: Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 34

def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#check_valid_creds(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse

Baseline implementation for the check_valid_creds REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

  verb, uri, query_string_params, body = ServiceStub.transcode_check_valid_creds_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_transfer_config(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the create_transfer_config REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 155

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

  verb, uri, query_string_params, body = ServiceStub.transcode_create_transfer_config_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

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

Baseline implementation for the delete_transfer_config REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 231

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

  verb, uri, query_string_params, body = ServiceStub.transcode_delete_transfer_config_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

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

Baseline implementation for the delete_transfer_run REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 459

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

  verb, uri, query_string_params, body = ServiceStub.transcode_delete_transfer_run_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


61
62
63
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 61

def endpoint
  @client_stub.endpoint
end

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

Baseline implementation for the enroll_data_sources REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 611

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

  verb, uri, query_string_params, body = ServiceStub.transcode_enroll_data_sources_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_data_source(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource

Baseline implementation for the get_data_source REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 79

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_data_source_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_transfer_config(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the get_transfer_config REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 269

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_transfer_config_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_transfer_run(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun

Baseline implementation for the get_transfer_run REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 421

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_transfer_run_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_data_sources(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse

Baseline implementation for the list_data_sources REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 117

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_data_sources_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_transfer_configs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse

Baseline implementation for the list_transfer_configs REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 307

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_transfer_configs_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_transfer_logs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse

Baseline implementation for the list_transfer_logs REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 535

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_transfer_logs_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_transfer_runs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse

Baseline implementation for the list_transfer_runs REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 497

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_transfer_runs_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#schedule_transfer_runs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse

Baseline implementation for the schedule_transfer_runs REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 345

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

  verb, uri, query_string_params, body = ServiceStub.transcode_schedule_transfer_runs_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#start_manual_transfer_runs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse

Baseline implementation for the start_manual_transfer_runs REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 383

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

  verb, uri, query_string_params, body = ServiceStub.transcode_start_manual_transfer_runs_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

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

Baseline implementation for the unenroll_data_sources REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 649

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

  verb, uri, query_string_params, body = ServiceStub.transcode_unenroll_data_sources_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


52
53
54
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 52

def universe_domain
  @client_stub.universe_domain
end

#update_transfer_config(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the update_transfer_config REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/rest/service_stub.rb', line 193

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

  verb, uri, query_string_params, body = ServiceStub.transcode_update_transfer_config_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,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end