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

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

Overview

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

Baseline implementation for the add_rule 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/security_policies/rest/service_stub.rb', line 55

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

  uri, body, _query_string_params = transcode_add_rule_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    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:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

Baseline implementation for the get REST call

Parameters:

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

    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) 


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

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

  yield result, response if block_given?
  result
end

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

Baseline implementation for the get_rule REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

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


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/compute/v1/security_policies/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::SecurityPolicyList

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) 


278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/compute/v1/security_policies/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::SecurityPolicyList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

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

Baseline implementation for the list_preconfigured_expression_sets 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/security_policies/rest/service_stub.rb', line 327

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

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


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

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

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

Baseline implementation for the patch_rule REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


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

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

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

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

Baseline implementation for the remove_rule REST call

Parameters:

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 468

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

  uri, _body, query_string_params = transcode_remove_rule_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_rule_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the add_rule REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



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

def transcode_add_rule_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/securityPolicies/#{request_pb.security_policy}/addRule"
  body = request_pb.security_policy_rule_resource.to_json
  query_string_params = {}

  [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



121
122
123
124
125
126
127
128
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 121

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



165
166
167
168
169
170
171
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 165

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

  [uri, body, query_string_params]
end

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

GRPC transcoding helper method for the get_rule REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



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

def transcode_get_rule_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/securityPolicies/#{request_pb.security_policy}/getRule"
  body = nil
  query_string_params = {}
  query_string_params["priority"] = request_pb.priority.to_s if request_pb.has_priority?

  [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/security_policies/rest/service_stub.rb', line 255

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

GRPC transcoding helper method for the list_preconfigured_expression_sets 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
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 349

def transcode_list_preconfigured_expression_sets_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/securityPolicies/listPreconfiguredExpressionSets"
  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_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/security_policies/rest/service_stub.rb', line 300

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



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

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

GRPC transcoding helper method for the patch_rule REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



445
446
447
448
449
450
451
452
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 445

def transcode_patch_rule_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/securityPolicies/#{request_pb.security_policy}/patchRule"
  body = request_pb.security_policy_rule_resource.to_json
  query_string_params = {}
  query_string_params["priority"] = request_pb.priority.to_s if request_pb.has_priority?

  [uri, body, query_string_params]
end

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

GRPC transcoding helper method for the remove_rule REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb', line 490

def transcode_remove_rule_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/securityPolicies/#{request_pb.security_policy}/removeRule"
  body = nil
  query_string_params = {}
  query_string_params["priority"] = request_pb.priority.to_s if request_pb.has_priority?

  [uri, body, query_string_params]
end