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 



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_get(id, opts = {}) ⇒ JobWrapper

Gets job by id Gets a job by id.



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

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.



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
81
 
# File 'lib/iron_titan/api/core_api.rb', line 38

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_get(opts = {}) ⇒ JobsWrapper

Get next job. Gets the next job in the queue, ready for processing.

Options Hash (opts):

  • :n (Integer) —

    Number of jobs to return.



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

def jobs_get(opts = {})
  data, status_code, headers = jobs_get_with_http_info(opts)
  return data
end

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

Get next job. Gets the next job in the queue, ready for processing.

Options Hash (opts):

  • :n (Integer) —

    Number of jobs to return.



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
 
# File 'lib/iron_titan/api/core_api.rb', line 98

def jobs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CoreApi#jobs_get ..."
  end
  
  # resource path
  local_var_path = "/jobs".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_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 a job.



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

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 a job.



156
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
199
 
# File 'lib/iron_titan/api/core_api.rb', line 156

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