class IronWorker::RunnerApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/iron_ruby/api/runner_api.rb, line 30
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

groups_name_tasks_id_error_post(name, id, body, opts = {}) click to toggle source

Mark task as failed. Task is marked as failed if it was in a valid state. Task's `finished_at` time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [TaskWrapper]

# File lib/iron_ruby/api/runner_api.rb, line 41
def groups_name_tasks_id_error_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_tasks_id_error_post_with_http_info(name, id, body, opts)
  return data
end
groups_name_tasks_id_error_post_with_http_info(name, id, body, opts = {}) click to toggle source

Mark task as failed. Task is marked as failed if it was in a valid state. Task&#39;s &#x60;finished_at&#x60; time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [Array<(TaskWrapper, Fixnum, Hash)>] TaskWrapper data, response status code and response headers

# File lib/iron_ruby/api/runner_api.rb, line 53
def groups_name_tasks_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_tasks_id_error_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_tasks_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_tasks_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_tasks_id_error_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/tasks/{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 => 'TaskWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_tasks_id_error_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
groups_name_tasks_id_start_post(name, id, body, opts = {}) click to toggle source

Mark task as started, ie: status = 'running' Task status is changed to 'running' if it was in a valid state before. Task's `started_at` time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [TaskWrapper]

# File lib/iron_ruby/api/runner_api.rb, line 106
def groups_name_tasks_id_start_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_tasks_id_start_post_with_http_info(name, id, body, opts)
  return data
end
groups_name_tasks_id_start_post_with_http_info(name, id, body, opts = {}) click to toggle source

Mark task as started, ie: status &#x3D; &#39;running&#39; Task status is changed to &#39;running&#39; if it was in a valid state before. Task&#39;s &#x60;started_at&#x60; time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [Array<(TaskWrapper, Fixnum, Hash)>] TaskWrapper data, response status code and response headers

# File lib/iron_ruby/api/runner_api.rb, line 118
def groups_name_tasks_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_tasks_id_start_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_tasks_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_tasks_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_tasks_id_start_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/tasks/{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 => 'TaskWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_tasks_id_start_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
groups_name_tasks_id_success_post(name, id, body, opts = {}) click to toggle source

Mark task as succeeded. Task status is changed to succeeded if it was in a valid state before. Task's `completed_at` time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [TaskWrapper]

# File lib/iron_ruby/api/runner_api.rb, line 171
def groups_name_tasks_id_success_post(name, id, body, opts = {})
  data, _status_code, _headers = groups_name_tasks_id_success_post_with_http_info(name, id, body, opts)
  return data
end
groups_name_tasks_id_success_post_with_http_info(name, id, body, opts = {}) click to toggle source

Mark task as succeeded. Task status is changed to succeeded if it was in a valid state before. Task&#39;s &#x60;completed_at&#x60; time is initialized. @param name Name of group for this set of tasks. @param id Task id @param body @param [Hash] opts the optional parameters @return [Array<(TaskWrapper, Fixnum, Hash)>] TaskWrapper data, response status code and response headers

# File lib/iron_ruby/api/runner_api.rb, line 183
def groups_name_tasks_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_tasks_id_success_post ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_tasks_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_tasks_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_tasks_id_success_post" if body.nil?
  # resource path
  local_var_path = "/groups/{name}/tasks/{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 => 'TaskWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RunnerApi#groups_name_tasks_id_success_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end