iron_titan

IronTitan - the Ruby gem for the Titan API

The ultimate, language agnostic, container based job processing framework.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.4.4
• Package version: 0.4.5
• Build date: 2016-06-20T22:31:54.061Z
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build iron_titan.gemspec

Then either install the gem locally:

gem install ./iron_titan-0.4.5.gem

(for development, run gem install --dev ./iron_titan-0.4.5.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'iron_titan', '~> 0.4.5'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'iron_titan', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'iron_titan'

api_instance = IronTitan::GroupsApi.new

begin
  #Get all group names.
  result = api_instance.groups_get
  p result
rescue IronTitan::ApiError => e
  puts "Exception when calling GroupsApi->groups_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost:8080/v1

Class	Method	HTTP request	Description
IronTitan::GroupsApi	groups_get	GET /groups	Get all group names.
IronTitan::GroupsApi	groups_name_get	GET /groups/name	Get information for a group.
IronTitan::GroupsApi	groups_name_put	PUT /groups/name	Create/update a job group.
IronTitan::GroupsApi	groups_post	POST /groups	Post new group
IronTitan::JobsApi	groups_name_jobs_get	GET /groups/name/jobs	Get job list by group name.
IronTitan::JobsApi	groups_name_jobs_id_cancel_post	POST /groups/name/jobs/id/cancel	Cancel a job.
IronTitan::JobsApi	groups_name_jobs_id_delete	DELETE /groups/name/jobs/id	Delete the job.
IronTitan::JobsApi	groups_name_jobs_id_error_post	POST /groups/name/jobs/id/error	Mark job as failed.
IronTitan::JobsApi	groups_name_jobs_id_get	GET /groups/name/jobs/id	Gets job by id
IronTitan::JobsApi	groups_name_jobs_id_log_get	GET /groups/name/jobs/id/log	Get the log of a completed job.
IronTitan::JobsApi	groups_name_jobs_id_log_post	POST /groups/name/jobs/id/log	Send in a log for storage.
IronTitan::JobsApi	groups_name_jobs_id_retry_post	POST /groups/name/jobs/id/retry	Retry a job.
IronTitan::JobsApi	groups_name_jobs_id_start_post	POST /groups/name/jobs/id/start	Mark job as started, ie: status = 'running'
IronTitan::JobsApi	groups_name_jobs_id_success_post	POST /groups/name/jobs/id/success	Mark job as succeeded.
IronTitan::JobsApi	groups_name_jobs_id_touch_post	POST /groups/name/jobs/id/touch	Extend job timeout.
IronTitan::JobsApi	groups_name_jobs_post	POST /groups/name/jobs	Enqueue Job
IronTitan::JobsApi	jobs_get	GET /jobs	Get next job.
IronTitan::RunnerApi	groups_name_jobs_id_error_post	POST /groups/name/jobs/id/error	Mark job as failed.
IronTitan::RunnerApi	groups_name_jobs_id_start_post	POST /groups/name/jobs/id/start	Mark job as started, ie: status = 'running'
IronTitan::RunnerApi	groups_name_jobs_id_success_post	POST /groups/name/jobs/id/success	Mark job as succeeded.

Documentation for Models

• IronTitan::Complete
• IronTitan::Error
• IronTitan::ErrorBody
• IronTitan::Group
• IronTitan::GroupWrapper
• IronTitan::GroupsWrapper
• IronTitan::IdStatus
• IronTitan::Job
• IronTitan::JobWrapper
• IronTitan::JobsWrapper
• IronTitan::NewJob
• IronTitan::NewJobsWrapper
• IronTitan::Start

Documentation for Authorization

All endpoints do not require authorization.