Class: Google::Cloud::OsConfig::V1::OsConfigService::Rest::ServiceStub

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

Overview

REST service stub for the OsConfigService 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
40
41
 
# File 'lib/google/cloud/os_config/v1/os_config_service/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,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#cancel_patch_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Baseline implementation for the cancel_patch_job REST call

Parameters:

  • request_pb (::Google::Cloud::OsConfig::V1::CancelPatchJobRequest) —

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

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 133

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

  verb, uri, query_string_params, body = ServiceStub.transcode_cancel_patch_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchJob.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Baseline implementation for the create_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 247

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

  verb, uri, query_string_params, body = ServiceStub.transcode_create_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchDeployment.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#delete_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty

Baseline implementation for the delete_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 361

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

  verb, uri, query_string_params, body = ServiceStub.transcode_delete_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#execute_patch_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Baseline implementation for the execute_patch_job REST call

Parameters:

  • request_pb (::Google::Cloud::OsConfig::V1::ExecutePatchJobRequest) —

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

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 57

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

  verb, uri, query_string_params, body = ServiceStub.transcode_execute_patch_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchJob.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Baseline implementation for the get_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 285

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchDeployment.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_patch_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Baseline implementation for the get_patch_job REST call

Parameters:

  • request_pb (::Google::Cloud::OsConfig::V1::GetPatchJobRequest) —

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

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 95

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_patch_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchJob.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_patch_deployments(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::ListPatchDeploymentsResponse

Baseline implementation for the list_patch_deployments REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 323

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_patch_deployments_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::ListPatchDeploymentsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_patch_job_instance_details(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsResponse

Baseline implementation for the list_patch_job_instance_details REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 209

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_patch_job_instance_details_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_patch_jobs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::ListPatchJobsResponse

Baseline implementation for the list_patch_jobs REST call

Parameters:

  • request_pb (::Google::Cloud::OsConfig::V1::ListPatchJobsRequest) —

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

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 171

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

  verb, uri, query_string_params, body = ServiceStub.transcode_list_patch_jobs_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::ListPatchJobsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#pause_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Baseline implementation for the pause_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 437

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

  verb, uri, query_string_params, body = ServiceStub.transcode_pause_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchDeployment.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#resume_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Baseline implementation for the resume_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 475

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

  verb, uri, query_string_params, body = ServiceStub.transcode_resume_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchDeployment.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#update_patch_deployment(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Baseline implementation for the update_patch_deployment REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/service_stub.rb', line 399

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

  verb, uri, query_string_params, body = ServiceStub.transcode_update_patch_deployment_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::OsConfig::V1::PatchDeployment.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end