class IronFunctions::TasksApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/iron_functions/api/tasks_api.rb, line 30
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

tasks_get(opts = {}) click to toggle source

Get next task. Gets the next task in the queue, ready for processing. Titan may return <=n tasks. Consumers should start processing tasks in order. Each returned task is set to `status` "running" and `started_at` is set to the current time. No other consumer can retrieve this task. @param [Hash] opts the optional parameters @option opts [Integer] :n Number of tasks to return. (default to 1) @return [TaskWrapper]

# File lib/iron_functions/api/tasks_api.rb, line 39
def tasks_get(opts = {})
  data, _status_code, _headers = tasks_get_with_http_info(opts)
  return data
end
tasks_get_with_http_info(opts = {}) click to toggle source

Get next task. Gets the next task in the queue, ready for processing. Titan may return &lt;&#x3D;n tasks. Consumers should start processing tasks in order. Each returned task is set to &#x60;status&#x60; "running&quot; and &#x60;started_at&#x60; is set to the current time. No other consumer can retrieve this task. @param [Hash] opts the optional parameters @option opts [Integer] :n Number of tasks to return. @return [Array<(TaskWrapper, Fixnum, Hash)>] TaskWrapper data, response status code and response headers

# File lib/iron_functions/api/tasks_api.rb, line 49
def tasks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TasksApi.tasks_get ..."
  end
  # resource path
  local_var_path = "/tasks".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'n'] = opts[:'n'] if !opts[:'n'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaskWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#tasks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end