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

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

Overview

REST service stub for the Images 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/images/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

#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::DeleteImageRequest) —

    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
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 55

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

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

Baseline implementation for the deprecate REST call

Parameters:

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

    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) 


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

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

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

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

Baseline implementation for the get REST call

Parameters:

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

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

  yield result, response if block_given?
  result
end

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

Baseline implementation for the get_from_family 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/images/rest/service_stub.rb', line 189

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

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

  yield result, response if block_given?
  result
end

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

Baseline implementation for the get_iam_policy REST call

Parameters:

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

    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
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 232

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

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

    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) 


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

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

Baseline implementation for the list REST call

Parameters:

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

    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) 


324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 324

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::ImageList.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::PatchImageRequest) —

    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) 


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

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_iam_policy(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters:

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

    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) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 419

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

  uri, body, _query_string_params = transcode_set_iam_policy_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Policy.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:

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

    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) 


463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 463

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


507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 507

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_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



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

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

GRPC transcoding helper method for the deprecate 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/images/rest/service_stub.rb', line 123

def transcode_deprecate_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.image}/deprecate"
  body = request_pb.deprecation_status_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_get_from_family_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_from_family 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/images/rest/service_stub.rb', line 210

def transcode_get_from_family_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images/family/#{request_pb.family}"
  body = nil
  query_string_params = {}

  [uri, body, query_string_params]
end

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

GRPC transcoding helper method for the get_iam_policy REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



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

def transcode_get_iam_policy_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/getIamPolicy"
  body = nil
  query_string_params = {}
  query_string_params["optionsRequestedPolicyVersion"] = request_pb.options_requested_policy_version.to_s if request_pb.has_options_requested_policy_version?

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

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



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

def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images"
  body = request_pb.image_resource.to_json
  query_string_params = {}
  query_string_params["forceCreate"] = request_pb.force_create.to_s if request_pb.has_force_create?
  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



346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 346

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



396
397
398
399
400
401
402
403
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 396

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

GRPC transcoding helper method for the set_iam_policy REST call

Parameters:

Returns:

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

    Uri, Body, Query string parameters



441
442
443
444
445
446
447
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 441

def transcode_set_iam_policy_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/setIamPolicy"
  body = request_pb.global_set_policy_request_resource.to_json
  query_string_params = {}

  [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



485
486
487
488
489
490
491
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 485

def transcode_set_labels_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/setLabels"
  body = request_pb.global_set_labels_request_resource.to_json
  query_string_params = {}

  [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



529
530
531
532
533
534
535
 
# File 'lib/google/cloud/compute/v1/images/rest/service_stub.rb', line 529

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

  [uri, body, query_string_params]
end