# 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](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.3.0
- Package version: 0.3.0
- Build date: 2016-04-05T21:57:28.555Z
- Build package: class io.swagger.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build iron_titan.gemspec
```

Then either install the gem locally:

```shell
gem install ./iron_titan-0.3.0.gem
```

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'iron_titan', '~> 0.3.0'

### 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:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:
```ruby
# 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**](docs/GroupsApi.md#groups_get) | **GET** /groups | Get all group names.
*IronTitan::GroupsApi* | [**groups_name_get**](docs/GroupsApi.md#groups_name_get) | **GET** /groups/{name} | Get information for a group.
*IronTitan::JobsApi* | [**groups_group_name_jobs_get**](docs/JobsApi.md#groups_group_name_jobs_get) | **GET** /groups/{group_name}/jobs | Get job list by group name.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_cancel_post**](docs/JobsApi.md#groups_group_name_jobs_id_cancel_post) | **POST** /groups/{group_name}/jobs/{id}/cancel | Cancel a job.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_delete**](docs/JobsApi.md#groups_group_name_jobs_id_delete) | **DELETE** /groups/{group_name}/jobs/{id} | Delete the job.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_error_post**](docs/JobsApi.md#groups_group_name_jobs_id_error_post) | **POST** /groups/{group_name}/jobs/{id}/error | Mark job as failed.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_get**](docs/JobsApi.md#groups_group_name_jobs_id_get) | **GET** /groups/{group_name}/jobs/{id} | Gets job by id
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_log_get**](docs/JobsApi.md#groups_group_name_jobs_id_log_get) | **GET** /groups/{group_name}/jobs/{id}/log | Get the log of a completed job.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_log_post**](docs/JobsApi.md#groups_group_name_jobs_id_log_post) | **POST** /groups/{group_name}/jobs/{id}/log | Send in a log for storage.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_retry_post**](docs/JobsApi.md#groups_group_name_jobs_id_retry_post) | **POST** /groups/{group_name}/jobs/{id}/retry | Retry a job.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_success_post**](docs/JobsApi.md#groups_group_name_jobs_id_success_post) | **POST** /groups/{group_name}/jobs/{id}/success | Mark job as succeeded.
*IronTitan::JobsApi* | [**groups_group_name_jobs_id_touch_post**](docs/JobsApi.md#groups_group_name_jobs_id_touch_post) | **POST** /groups/{group_name}/jobs/{id}/touch | Extend job timeout.
*IronTitan::JobsApi* | [**groups_group_name_jobs_post**](docs/JobsApi.md#groups_group_name_jobs_post) | **POST** /groups/{group_name}/jobs | Enqueue Job
*IronTitan::JobsApi* | [**jobs_get**](docs/JobsApi.md#jobs_get) | **GET** /jobs | Get next job.


## Documentation for Models

 - [IronTitan::Error](docs/Error.md)
 - [IronTitan::ErrorBody](docs/ErrorBody.md)
 - [IronTitan::Group](docs/Group.md)
 - [IronTitan::GroupWrapper](docs/GroupWrapper.md)
 - [IronTitan::GroupsWrapper](docs/GroupsWrapper.md)
 - [IronTitan::IdStatus](docs/IdStatus.md)
 - [IronTitan::Job](docs/Job.md)
 - [IronTitan::JobWrapper](docs/JobWrapper.md)
 - [IronTitan::JobsWrapper](docs/JobsWrapper.md)
 - [IronTitan::NewJob](docs/NewJob.md)
 - [IronTitan::NewJobsWrapper](docs/NewJobsWrapper.md)
 - [IronTitan::Reason](docs/Reason.md)


## Documentation for Authorization

 All endpoints do not require authorization.