Class: IronFunctions::TasksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_functions/api/tasks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TasksApi

Returns a new instance of TasksApi.



30
31
32
 
# File 'lib/iron_functions/api/tasks_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/iron_functions/api/tasks_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#tasks_get(opts = {}) ⇒ TaskWrapper

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :n (Integer) —

    Number of tasks to return. (default to 1)

Returns:



39
40
41
42
 
# 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 = {}) ⇒ Array<(TaskWrapper, Fixnum, Hash)>

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; &quot;running&quot; and &#x60;started_at&#x60; is set to the current time. No other consumer can retrieve this task.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :n (Integer) —

    Number of tasks to return.

Returns:

  • (Array<(TaskWrapper, Fixnum, Hash)>) —

    TaskWrapper data, response status code and response headers



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# 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