Class: IronTitan::CoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_titan/api/core_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CoreApi

Returns a new instance of CoreApi.



19
20
21
 
# File 'lib/iron_titan/api/core_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/iron_titan/api/core_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#job_id_delete(id, opts = {}) ⇒ nil

Delete the job. Delete only succeeds if job status is one of ‘succeededn| failed | cancelled`. Cancel a job if it is another state and needs tonbe deleted. All information about the job, including the log, isnirretrievably lost when this is invoked.

Parameters:

  • id —

    Job id

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/iron_titan/api/core_api.rb', line 28

def job_id_delete(id, opts = {})
  job_id_delete_with_http_info(id, opts)
  return nil
end

#job_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the job. Delete only succeeds if job status is one of ‘succeededn| failed | cancelled`. Cancel a job if it is another state and needs tonbe deleted. All information about the job, including the log, isnirretrievably lost when this is invoked.

Parameters:

  • id —

    Job id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
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
 
# File 'lib/iron_titan/api/core_api.rb', line 38

def job_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CoreApi#job_id_delete ..."
  end
  
  # verify the required parameter 'id' is set
  fail "Missing the required parameter 'id' when calling job_id_delete" if id.nil?
  
  # resource path
  local_var_path = "/job/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#job_id_get(id, opts = {}) ⇒ JobWrapper

Gets job by id Gets a job by id.

Parameters:

  • id —

    Job id

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/iron_titan/api/core_api.rb', line 87

def job_id_get(id, opts = {})
  data, status_code, headers = job_id_get_with_http_info(id, opts)
  return data
end

#job_id_get_with_http_info(id, opts = {}) ⇒ Array<(JobWrapper, Fixnum, Hash)>

Gets job by id Gets a job by id.

Parameters:

  • id —

    Job id

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

    the optional parameters

Returns:

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

    JobWrapper data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/iron_titan/api/core_api.rb', line 97

def job_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CoreApi#job_id_get ..."
  end
  
  # verify the required parameter 'id' is set
  fail "Missing the required parameter 'id' when calling job_id_get" if id.nil?
  
  # resource path
  local_var_path = "/job/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'JobWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#job_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#jobs_consume_get(opts = {}) ⇒ JobsWrapper

Get next job. Gets the next job in the queue, ready for processing. Titan may return <=n jobs. Consumers should start processing jobs in order. Each returned job is set to ‘status` "running" and `started_at` is set to the current time. No other consumer can retrieve this job.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :n (Integer) —

    Number of jobs to return. (default to 1)

Returns:



147
148
149
150
 
# File 'lib/iron_titan/api/core_api.rb', line 147

def jobs_consume_get(opts = {})
  data, status_code, headers = jobs_consume_get_with_http_info(opts)
  return data
end

#jobs_consume_get_with_http_info(opts = {}) ⇒ Array<(JobsWrapper, Fixnum, Hash)>

Get next job. Gets the next job in the queue, ready for processing. Titan may return &lt;=n jobs. Consumers should start processing jobs in order. Each returned job is set to ‘status` &quot;running&quot; and `started_at` is set to the current time. No other consumer can retrieve this job.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :n (Integer) —

    Number of jobs to return.

Returns:

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

    JobsWrapper data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/iron_titan/api/core_api.rb', line 157

def jobs_consume_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CoreApi#jobs_consume_get ..."
  end
  
  # resource path
  local_var_path = "/jobs/consume".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'n'] = opts[:'n'] if opts[:'n']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'JobsWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#jobs_consume_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#jobs_post(body, opts = {}) ⇒ JobsWrapper

Enqueue Job Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.

Parameters:

  • body —

    Array of jobs to post.

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/iron_titan/api/core_api.rb', line 205

def jobs_post(body, opts = {})
  data, status_code, headers = jobs_post_with_http_info(body, opts)
  return data
end

#jobs_post_with_http_info(body, opts = {}) ⇒ Array<(JobsWrapper, Fixnum, Hash)>

Enqueue Job Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.

Parameters:

  • body —

    Array of jobs to post.

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

    the optional parameters

Returns:

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

    JobsWrapper data, response status code and response headers



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/iron_titan/api/core_api.rb', line 215

def jobs_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CoreApi#jobs_post ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling jobs_post" if body.nil?
  
  # resource path
  local_var_path = "/jobs".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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