Class: Google::Cloud::Compute::V1::BackendServices::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb

Overview

REST service stub for the BackendServices 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:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



33
34
35
36
37
38
39
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 33

def initialize endpoint:, 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, credentials: credentials
end

Instance Method Details

#add_signed_url_key(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the add_signed_url_key REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 55

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

  uri, body, query_string_params = transcode_add_signed_url_key_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#aggregated_list(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::BackendServiceAggregatedList

Baseline implementation for the aggregated_list REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 101

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

  uri, _body, query_string_params = transcode_aggregated_list_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::BackendServiceAggregatedList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#delete(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the delete REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 151

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

  uri, _body, query_string_params = transcode_delete_request request_pb
  response = @client_stub.make_delete_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#delete_signed_url_key(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the delete_signed_url_key REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 196

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

  uri, _body, query_string_params = transcode_delete_signed_url_key_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#get(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::BackendService

Baseline implementation for the get REST call

Parameters:

  • request_pb (::Google::Cloud::Compute::V1::GetBackendServiceRequest) —

    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, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 242

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

  uri, _body, _query_string_params = transcode_get_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::BackendService.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#get_health(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::BackendServiceGroupHealth

Baseline implementation for the get_health REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 285

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

  uri, body, _query_string_params = transcode_get_health_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::BackendServiceGroupHealth.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#insert(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the insert REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 329

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

  uri, body, query_string_params = transcode_insert_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#list(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::BackendServiceList

Baseline implementation for the list REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 375

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

  uri, _body, query_string_params = transcode_list_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::BackendServiceList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#patch(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the patch REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 424

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

  uri, body, query_string_params = transcode_patch_request request_pb
  response = @client_stub.make_patch_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#set_edge_security_policy(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the set_edge_security_policy REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 470

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

  uri, body, query_string_params = transcode_set_edge_security_policy_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#set_security_policy(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the set_security_policy REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 516

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

  uri, body, query_string_params = transcode_set_security_policy_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#transcode_add_signed_url_key_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the add_signed_url_key REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 78

def transcode_add_signed_url_key_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}/addSignedUrlKey"
  body = request_pb.signed_url_key_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_aggregated_list_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the aggregated_list REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 123

def transcode_aggregated_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/aggregated/backendServices"
  body = nil
  query_string_params = {}
  query_string_params["filter"] = request_pb.filter.to_s if request_pb.has_filter?
  query_string_params["includeAllScopes"] = request_pb.include_all_scopes.to_s if request_pb.has_include_all_scopes?
  query_string_params["maxResults"] = request_pb.max_results.to_s if request_pb.has_max_results?
  query_string_params["orderBy"] = request_pb.order_by.to_s if request_pb.has_order_by?
  query_string_params["pageToken"] = request_pb.page_token.to_s if request_pb.has_page_token?
  query_string_params["returnPartialSuccess"] = request_pb.return_partial_success.to_s if request_pb.has_return_partial_success?

  [uri, body, query_string_params]
end

#transcode_delete_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the delete REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



173
174
175
176
177
178
179
180
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 173

def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}"
  body = nil
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_delete_signed_url_key_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the delete_signed_url_key REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



218
219
220
221
222
223
224
225
226
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 218

def transcode_delete_signed_url_key_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}/deleteSignedUrlKey"
  body = nil
  query_string_params = {}
  query_string_params["keyName"] = request_pb.key_name.to_s
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_get_health_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_health REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



307
308
309
310
311
312
313
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 307

def transcode_get_health_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}/getHealth"
  body = request_pb.resource_group_reference_resource.to_json
  query_string_params = {}

  [uri, body, query_string_params]
end

#transcode_get_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



263
264
265
266
267
268
269
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 263

def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}"
  body = nil
  query_string_params = {}

  [uri, body, query_string_params]
end

#transcode_insert_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the insert REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



352
353
354
355
356
357
358
359
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 352

def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices"
  body = request_pb.backend_service_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_list_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 397

def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices"
  body = nil
  query_string_params = {}
  query_string_params["filter"] = request_pb.filter.to_s if request_pb.has_filter?
  query_string_params["maxResults"] = request_pb.max_results.to_s if request_pb.has_max_results?
  query_string_params["orderBy"] = request_pb.order_by.to_s if request_pb.has_order_by?
  query_string_params["pageToken"] = request_pb.page_token.to_s if request_pb.has_page_token?
  query_string_params["returnPartialSuccess"] = request_pb.return_partial_success.to_s if request_pb.has_return_partial_success?

  [uri, body, query_string_params]
end

#transcode_patch_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the patch REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



447
448
449
450
451
452
453
454
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 447

def transcode_patch_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}"
  body = request_pb.backend_service_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_set_edge_security_policy_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_edge_security_policy REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



493
494
495
496
497
498
499
500
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 493

def transcode_set_edge_security_policy_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}/setEdgeSecurityPolicy"
  body = request_pb.security_policy_reference_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_set_security_policy_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_security_policy REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



539
540
541
542
543
544
545
546
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 539

def transcode_set_security_policy_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}/setSecurityPolicy"
  body = request_pb.security_policy_reference_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#transcode_update_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the update REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String})) —

    Uri, Body, Query string parameters



585
586
587
588
589
590
591
592
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 585

def transcode_update_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/backendServices/#{request_pb.backend_service}"
  body = request_pb.backend_service_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end

#update(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the update REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb', line 562

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

  uri, body, query_string_params = transcode_update_request request_pb
  response = @client_stub.make_put_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end