Class: IronTitan::RunnerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RunnerApi

Returns a new instance of RunnerApi.



30
31
32
 
# File 'lib/iron_titan/api/runner_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_titan/api/runner_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#groups_name_jobs_id_error_post(name, id, body, opts = {}) ⇒ JobWrapper

Mark job as failed. Job is marked as failed if it was in a valid state. Job’s ‘finished_at` time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:



41
42
43
44
 
# File 'lib/iron_titan/api/runner_api.rb', line 41

def groups_name_jobs_id_error_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_jobs_id_error_post_with_http_info(name, id, body, opts)
  return data
end

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

Mark job as failed. Job is marked as failed if it was in a valid state. Job&#39;s &#x60;finished_at&#x60; time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:

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

    JobWrapper data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
 
# File 'lib/iron_titan/api/runner_api.rb', line 53

def groups_name_jobs_id_error_post_with_http_info(name, id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_error_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_error_post" if name.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_error_post" if id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_error_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/jobs/{id}/error".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # 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 = @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 => 'JobWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_jobs_id_error_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_name_jobs_id_start_post(name, id, body, opts = {}) ⇒ JobWrapper

Mark job as started, ie: status = ‘running’ Job status is changed to ‘running’ if it was in a valid state before. Job’s ‘started_at` time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:



106
107
108
109
 
# File 'lib/iron_titan/api/runner_api.rb', line 106

def groups_name_jobs_id_start_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_jobs_id_start_post_with_http_info(name, id, body, opts)
  return data
end

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

Mark job as started, ie: status &#x3D; &#39;running&#39; Job status is changed to &#39;running&#39; if it was in a valid state before. Job&#39;s &#x60;started_at&#x60; time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:

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

    JobWrapper data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/iron_titan/api/runner_api.rb', line 118

def groups_name_jobs_id_start_post_with_http_info(name, id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_start_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_start_post" if name.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_start_post" if id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_start_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/jobs/{id}/start".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # 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 = @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 => 'JobWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_jobs_id_start_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_name_jobs_id_success_post(name, id, body, opts = {}) ⇒ JobWrapper

Mark job as succeeded. Job status is changed to succeeded if it was in a valid state before. Job’s ‘completed_at` time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:



171
172
173
174
 
# File 'lib/iron_titan/api/runner_api.rb', line 171

def groups_name_jobs_id_success_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_jobs_id_success_post_with_http_info(name, id, body, opts)
  return data
end

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

Mark job as succeeded. Job status is changed to succeeded if it was in a valid state before. Job&#39;s &#x60;completed_at&#x60; time is initialized.

Parameters:

  • name —

    Name of group for this set of jobs.

  • id —

    Job id

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

    the optional parameters

Returns:

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

    JobWrapper data, response status code and response headers



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/iron_titan/api/runner_api.rb', line 183

def groups_name_jobs_id_success_post_with_http_info(name, id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_success_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_success_post" if name.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_success_post" if id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_success_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/jobs/{id}/success".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # 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 = @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 => 'JobWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_jobs_id_success_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end