Class: Google::Apis::CloudtasksV2beta2::CloudTasksService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudtasksV2beta2::CloudTasksService
- Defined in:
- generated/google/apis/cloudtasks_v2beta2/service.rb
Overview
Cloud Tasks API
Manages the execution of large numbers of distributed requests.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Google::Apis::Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Acknowledges a pull task.
-
#cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Cancel a pull task's lease.
-
#create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Creates a queue.
-
#create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Creates a task and adds it to a queue.
-
#delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Deletes a queue.
-
#delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Deletes a task.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Location
Gets information about a location.
-
#get_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Gets a queue.
-
#get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Gets a task.
-
#get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Policy
Gets the access control policy for a Queue.
-
#initialize ⇒ CloudTasksService
constructor
A new instance of CloudTasksService.
-
#lease_tasks(parent, lease_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::LeaseTasksResponse
Leases tasks from a pull queue for lease_duration.
-
#list_project_location_queue_tasks(parent, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListTasksResponse
Lists the tasks in a queue.
-
#list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListQueuesResponse
Lists queues.
-
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListLocationsResponse
Lists information about the supported locations for this service.
-
#patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Updates a queue.
-
#pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Pauses the queue.
-
#purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Purges a queue by deleting all of its tasks.
-
#renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Renew the current lease of a pull task.
-
#resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Resume a queue.
-
#run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Forces a task to run now.
-
#set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Policy
Sets the access control policy for a Queue.
-
#test_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse
Returns permissions that a caller has on a Queue.
Methods inherited from Google::Apis::Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Google::Apis::Core::Logging
Constructor Details
#initialize ⇒ CloudTasksService
Returns a new instance of CloudTasksService
45 46 47 48 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 45 def initialize super('https://cloudtasks.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.
641 642 643 644 645 646 647 648 649 650 651 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 641 def acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:acknowledge', ) command.request_representation = Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest::Representation command.request_object = acknowledge_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks.
680 681 682 683 684 685 686 687 688 689 690 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 680 def cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:cancelLease', ) command.request_representation = Google::Apis::CloudtasksV2beta2::CancelLeaseRequest::Representation command.request_object = cancel_lease_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of
whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml
or queue.xml
file to manage your queues.
Read
Overview of Queue Management and queue.yaml
before using this method.
155 156 157 158 159 160 161 162 163 164 165 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 155 def create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/queues', ) command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.request_object = queue_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command.
- For App Engine queues, the maximum task size is 100KB.
- For pull queues, the maximum task size is 1MB.
720 721 722 723 724 725 726 727 728 729 730 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 720 def create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/tasks', ) command.request_representation = Google::Apis::CloudtasksV2beta2::CreateTaskRequest::Representation command.request_object = create_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Deletes a queue.
This command will delete the queue even if it has tasks in it.
Note: If you delete a queue, a queue with the same name can't be created
for 7 days.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml
or queue.xml
file to manage your queues.
Read
Overview of Queue Management and queue.yaml
before using this method.
198 199 200 201 202 203 204 205 206 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 198 def delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', ) command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty
Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed.
757 758 759 760 761 762 763 764 765 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 757 def delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', ) command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Location
Gets information about a location.
70 71 72 73 74 75 76 77 78 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 70 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', ) command.response_representation = Google::Apis::CloudtasksV2beta2::Location::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Gets a queue.
230 231 232 233 234 235 236 237 238 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 230 def get_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', ) command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Gets a task.
800 801 802 803 804 805 806 807 808 809 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 800 def get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', ) command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['name'] = name unless name.nil? command.query['responseView'] = response_view unless response_view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Policy
Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following Google IAM permission on the specified resource parent:
cloudtasks.queues.getIamPolicy
268 269 270 271 272 273 274 275 276 277 278 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 268 def get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#lease_tasks(parent, lease_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::LeaseTasksResponse
Leases tasks from a pull queue for lease_duration. This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task. The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded.
852 853 854 855 856 857 858 859 860 861 862 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 852 def lease_tasks(parent, lease_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/tasks:lease', ) command.request_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksRequest::Representation command.request_object = lease_tasks_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_queue_tasks(parent, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListTasksResponse
Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.
918 919 920 921 922 923 924 925 926 927 928 929 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 918 def list_project_location_queue_tasks(parent, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/tasks', ) command.response_representation = Google::Apis::CloudtasksV2beta2::ListTasksResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListTasksResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['responseView'] = response_view unless response_view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListQueuesResponse
Lists queues. Queues are returned in lexicographical order.
328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 328 def list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/queues', ) command.response_representation = Google::Apis::CloudtasksV2beta2::ListQueuesResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListQueuesResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListLocationsResponse
Lists information about the supported locations for this service.
106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 106 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}/locations', ) command.response_representation = Google::Apis::CloudtasksV2beta2::ListLocationsResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Updates a queue.
This method creates the queue if it does not exist and updates
the queue if it does exist.
Queues created with this method allow tasks to live for a maximum of 31
days. After a task is 31 days old, the task will be deleted regardless of
whether
it was dispatched or not.
WARNING: Using this method may have unintended side effects if you are
using an App Engine queue.yaml
or queue.xml
file to manage your queues.
Read
Overview of Queue Management and queue.yaml
before using this method.
392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 392 def patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', ) command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.request_object = queue_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.
433 434 435 436 437 438 439 440 441 442 443 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 433 def pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:pause', ) command.request_representation = Google::Apis::CloudtasksV2beta2::PauseQueueRequest::Representation command.request_object = pause_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.
471 472 473 474 475 476 477 478 479 480 481 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 471 def purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:purge', ) command.request_representation = Google::Apis::CloudtasksV2beta2::PurgeQueueRequest::Representation command.request_object = purge_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Renew the current lease of a pull task. The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time.
957 958 959 960 961 962 963 964 965 966 967 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 957 def renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:renewLease', ) command.request_representation = Google::Apis::CloudtasksV2beta2::RenewLeaseRequest::Representation command.request_object = renew_lease_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue
Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks.
516 517 518 519 520 521 522 523 524 525 526 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 516 def resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:resume', ) command.request_representation = Google::Apis::CloudtasksV2beta2::ResumeQueueRequest::Representation command.request_object = resume_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task
Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. RunTask cannot be called on a pull task.
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 1012 def run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:run', ) command.request_representation = Google::Apis::CloudtasksV2beta2::RunTaskRequest::Representation command.request_object = run_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Policy
Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following Google IAM permission on the specified resource parent:
cloudtasks.queues.setIamPolicy
557 558 559 560 561 562 563 564 565 566 567 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 557 def set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse
Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
596 597 598 599 600 601 602 603 604 605 606 |
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 596 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |