class IronTitan::RunnerApi
Attributes
Public Class Methods
# File lib/iron_titan/api/runner_api.rb, line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Mark job as failed. Job
is marked as failed if it was in a valid state. Job's `finished_at` time is initialized. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [JobWrapper]
# 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
Mark job as failed. Job
is marked as failed if it was in a valid state. Job's `finished_at` time is initialized. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [Array<(JobWrapper
, Fixnum, Hash)>] JobWrapper
data, response status code and response headers
# 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
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. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [JobWrapper]
# 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
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. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [Array<(JobWrapper
, Fixnum, Hash)>] JobWrapper
data, response status code and response headers
# 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
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. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [JobWrapper]
# 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
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. @param name Name of group for this set of jobs. @param id Job
id @param body @param [Hash] opts the optional parameters @return [Array<(JobWrapper
, Fixnum, Hash)>] JobWrapper
data, response status code and response headers
# 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