generated/google-apis-cloudtasks_v2beta2/lib/google/apis/cloudtasks_v2beta2/service.rb
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', options)
          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
# 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.
# @param [String] name
#   Required. The queue name. For example: `projects/PROJECT_ID/location/
#   LOCATION_ID/queues/QUEUE_ID`
# @param [Google::Apis::CloudtasksV2beta2::PurgeQueueRequest] purge_queue_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::Queue] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudtasksV2beta2::Queue]
#
# @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
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.
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 .
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', options)
          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
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' , options ) 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
Purges a queue by deleting all of its tasks.
Purges a queue by deleting all of its tasks .
None
Google::Apis::CloudtasksV2beta2::Queue
[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
name
purge_queue_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