Class: Google::Cloud::Tasks::V2::CloudTasks::Rest::ServiceStub
- Inherits:
-
Object
- Object
- Google::Cloud::Tasks::V2::CloudTasks::Rest::ServiceStub
- Defined in:
- lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb
Overview
REST service stub for the CloudTasks service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Instance Method Summary collapse
-
#create_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the create_queue REST call.
-
#create_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the create_task REST call.
-
#delete_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Baseline implementation for the delete_queue REST call.
-
#delete_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Baseline implementation for the delete_task REST call.
-
#endpoint ⇒ String
The effective endpoint.
-
#get_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Baseline implementation for the get_iam_policy REST call.
-
#get_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the get_queue REST call.
-
#get_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the get_task REST call.
-
#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub
constructor
A new instance of ServiceStub.
-
#list_queues(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::ListQueuesResponse
Baseline implementation for the list_queues REST call.
-
#list_tasks(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::ListTasksResponse
Baseline implementation for the list_tasks REST call.
-
#pause_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the pause_queue REST call.
-
#purge_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the purge_queue REST call.
-
#resume_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the resume_queue REST call.
-
#run_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the run_task REST call.
-
#set_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Baseline implementation for the set_iam_policy REST call.
-
#test_iam_permissions(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Baseline implementation for the test_iam_permissions REST call.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the update_queue REST call.
Constructor Details
#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub
Returns a new instance of ServiceStub.
33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 33 def initialize endpoint:, endpoint_template:, universe_domain:, 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, endpoint_template: endpoint_template, universe_domain: universe_domain, credentials: credentials, numeric_enums: true, raise_faraday_errors: false end |
Instance Method Details
#create_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the create_queue REST call
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 154 def create_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_create_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#create_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the create_task REST call
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 572 def create_task request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_create_task_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#delete_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Baseline implementation for the delete_queue REST call
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 230 def delete_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_delete_queue_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: ) 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 |
#delete_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Baseline implementation for the delete_task REST call
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 610 def delete_task request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_delete_task_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: ) 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 |
#endpoint ⇒ String
The effective endpoint
60 61 62 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 60 def endpoint @client_stub.endpoint end |
#get_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Baseline implementation for the get_iam_policy REST call
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 382 def get_iam_policy request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_get_iam_policy_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#get_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the get_queue REST call
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 116 def get_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_get_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#get_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the get_task REST call
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 534 def get_task request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_get_task_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#list_queues(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::ListQueuesResponse
Baseline implementation for the list_queues REST call
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 78 def list_queues request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_list_queues_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::ListQueuesResponse.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#list_tasks(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::ListTasksResponse
Baseline implementation for the list_tasks REST call
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 496 def list_tasks request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_list_tasks_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::ListTasksResponse.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#pause_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the pause_queue REST call
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 306 def pause_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_pause_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#purge_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the purge_queue REST call
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 268 def purge_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_purge_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#resume_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the resume_queue REST call
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 344 def resume_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_resume_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#run_task(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Task
Baseline implementation for the run_task REST call
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 648 def run_task request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_run_task_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#set_iam_policy(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Baseline implementation for the set_iam_policy REST call
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 420 def set_iam_policy request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_set_iam_policy_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#test_iam_permissions(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Baseline implementation for the test_iam_permissions REST call
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 458 def request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub. 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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Iam::V1::TestIamPermissionsResponse.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |
#universe_domain ⇒ String
The effective universe domain
51 52 53 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 51 def universe_domain @client_stub.universe_domain end |
#update_queue(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Tasks::V2::Queue
Baseline implementation for the update_queue REST call
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb', line 192 def update_queue request_pb, = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = ServiceStub.transcode_update_queue_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: ) operation = ::Gapic::Rest::TransportOperation.new response result = ::Google::Cloud::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true yield result, operation if block_given? result end |