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

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

Overview

REST service stub for the Networks 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/networks/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_peering(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the add_peering REST call

Parameters:

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

    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) 


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

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

  uri, body, query_string_params = transcode_add_peering_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

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

Baseline implementation for the delete REST call

Parameters:

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

    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) 


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

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

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

Baseline implementation for the get REST call

Parameters:

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

    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) 


146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 146

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::Network.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

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

Baseline implementation for the get_effective_firewalls REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 189

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

  uri, _body, _query_string_params = transcode_get_effective_firewalls_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::NetworksGetEffectiveFirewallsResponse.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:

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

    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) 


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 232

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::NetworkList

Baseline implementation for the list REST call

Parameters:

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

    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) 


278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 278

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::NetworkList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

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

Baseline implementation for the list_peering_routes REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 327

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

  uri, _body, query_string_params = transcode_list_peering_routes_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::ExchangedPeeringRoutesList.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:

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

    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) 


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 379

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

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

Baseline implementation for the remove_peering REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

  uri, body, query_string_params = transcode_remove_peering_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

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

Baseline implementation for the switch_to_custom_mode REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

  uri, _body, query_string_params = transcode_switch_to_custom_mode_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

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

GRPC transcoding helper method for the add_peering 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/networks/rest/service_stub.rb', line 78

def transcode_add_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/addPeering"
  body = request_pb.networks_add_peering_request_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_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



123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 123

def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  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_get_effective_firewalls_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_effective_firewalls REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



210
211
212
213
214
215
216
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 210

def transcode_get_effective_firewalls_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/getEffectiveFirewalls"
  body = nil
  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



167
168
169
170
171
172
173
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 167

def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  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



255
256
257
258
259
260
261
262
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 255

def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks"
  body = request_pb.network_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_peering_routes_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list_peering_routes REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 349

def transcode_list_peering_routes_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/listPeeringRoutes"
  body = nil
  query_string_params = {}
  query_string_params["direction"] = request_pb.direction.to_s if request_pb.has_direction?
  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["peeringName"] = request_pb.peering_name.to_s if request_pb.has_peering_name?
  query_string_params["region"] = request_pb.region.to_s if request_pb.has_region?
  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_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



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 300

def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks"
  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



402
403
404
405
406
407
408
409
 
# File 'lib/google/cloud/compute/v1/networks/rest/service_stub.rb', line 402

def transcode_patch_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  body = request_pb.network_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_remove_peering_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the remove_peering REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



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

def transcode_remove_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/removePeering"
  body = request_pb.networks_remove_peering_request_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_switch_to_custom_mode_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the switch_to_custom_mode 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/networks/rest/service_stub.rb', line 493

def transcode_switch_to_custom_mode_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/switchToCustomMode"
  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_update_peering_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the update_peering 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/networks/rest/service_stub.rb', line 539

def transcode_update_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/updatePeering"
  body = request_pb.networks_update_peering_request_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_peering(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the update_peering 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/networks/rest/service_stub.rb', line 516

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

  uri, body, query_string_params = transcode_update_peering_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