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

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

Overview

REST service stub for the VpnGateways 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/vpn_gateways/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

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

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) 


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

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::VpnGatewayAggregatedList.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::DeleteVpnGatewayRequest) —

    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) 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 105

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

Baseline implementation for the get REST call

Parameters:

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

    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) 


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

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

  yield result, response if block_given?
  result
end

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

Baseline implementation for the get_status REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 193

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

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

    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) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 236

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

Baseline implementation for the list REST call

Parameters:

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

    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) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 282

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

  yield result, response if block_given?
  result
end

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

Baseline implementation for the set_labels REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

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

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

Baseline implementation for the test_iam_permissions REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

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

  yield result, response if block_given?
  result
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



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 77

def transcode_aggregated_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/aggregated/vpnGateways"
  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



127
128
129
130
131
132
133
134
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 127

def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways/#{request_pb.vpn_gateway}"
  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_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



171
172
173
174
175
176
177
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 171

def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways/#{request_pb.vpn_gateway}"
  body = nil
  query_string_params = {}

  [uri, body, query_string_params]
end

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

GRPC transcoding helper method for the get_status REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



214
215
216
217
218
219
220
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 214

def transcode_get_status_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways/#{request_pb.vpn_gateway}/getStatus"
  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



259
260
261
262
263
264
265
266
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 259

def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways"
  body = request_pb.vpn_gateway_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



304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 304

def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways"
  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_set_labels_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_labels REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



354
355
356
357
358
359
360
361
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 354

def transcode_set_labels_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways/#{request_pb.resource}/setLabels"
  body = request_pb.region_set_labels_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_test_iam_permissions_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the test_iam_permissions REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



399
400
401
402
403
404
405
 
# File 'lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb', line 399

def transcode_test_iam_permissions_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/vpnGateways/#{request_pb.resource}/testIamPermissions"
  body = request_pb.test_permissions_request_resource.to_json
  query_string_params = {}

  [uri, body, query_string_params]
end