generated/google-apis-cloudtasks_v2beta2/lib/google/apis/cloudtasks_v2beta2/service.rb
# 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.
# @param [String] parent
#   Required. The queue name. For example: `projects/PROJECT_ID/locations/
#   LOCATION_ID/queues/QUEUE_ID`
# @param [Google::Apis::CloudtasksV2beta2::LeaseTasksRequest] lease_tasks_request_object
# @param [String] fields
#   Selector specifying which fields to include in a partial response.
# @param [String] quota_user
#   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.
# @param [Google::Apis::RequestOptions] options
#   Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudtasksV2beta2::LeaseTasksResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudtasksV2beta2::LeaseTasksResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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.
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 .
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', options)
          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
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' , options ) 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
Leases tasks from a pull queue for lease_duration.
Leases tasks from a pull queue for lease_duration .
None
Google::Apis::CloudtasksV2beta2::LeaseTasksResponse
[Google::Apis::ServerError] An error occurred on the server and the request can be retried
[ Google :: Apis :: ServerError ] An error occurred on the server and the request can be retried
[Google::Apis::ClientError] The request is invalid and should not be retried without modification
[ Google :: Apis :: ClientError ] The request is invalid and should not be retried without modification
[Google::Apis::AuthorizationError] Authorization is required
[ Google :: Apis :: AuthorizationError ] Authorization is required
parent
lease_tasks_request_object
fields
quota_user
options
block
options Request-specific options
options Request - specific options
]
Result & error if block supplied
Result & error if block supplied
result
parsed result object
parsed result object
err
error object if request failed
error object if request failed