iron_titan

IronTitan - JavaScript client for iron_titan The ultimate, language agnostic, container based job processing framework. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.4.9
• Package version: 0.4.9
• Build date: 2016-06-21T18:33:20.525Z
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install iron_titan --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/iron_titan then install it via:

    npm install YOUR_USERNAME/iron_titan --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var IronTitan = require('iron_titan');

var api = new IronTitan.GroupsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsGet(callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- IronTitan.GroupsApi | groupsGet | GET /groups | Get all group names. IronTitan.GroupsApi | groupsNameGet | GET /groups/{name} | Get information for a group. IronTitan.GroupsApi | groupsNamePut | PUT /groups/{name} | Create/update a job group. IronTitan.GroupsApi | groupsPost | POST /groups | Post new group IronTitan.JobsApi | groupsNameJobsGet | GET /groups/{name}/jobs | Get job list by group name. IronTitan.JobsApi | groupsNameJobsIdCancelPost | POST /groups/{name}/jobs/{id}/cancel | Cancel a job. IronTitan.JobsApi | groupsNameJobsIdDelete | DELETE /groups/{name}/jobs/{id} | Delete the job. IronTitan.JobsApi | groupsNameJobsIdErrorPost | POST /groups/{name}/jobs/{id}/error | Mark job as failed. IronTitan.JobsApi | groupsNameJobsIdGet | GET /groups/{name}/jobs/{id} | Gets job by id IronTitan.JobsApi | groupsNameJobsIdLogGet | GET /groups/{name}/jobs/{id}/log | Get the log of a completed job. IronTitan.JobsApi | groupsNameJobsIdLogPost | POST /groups/{name}/jobs/{id}/log | Send in a log for storage. IronTitan.JobsApi | groupsNameJobsIdRetryPost | POST /groups/{name}/jobs/{id}/retry | Retry a job. IronTitan.JobsApi | groupsNameJobsIdStartPost | POST /groups/{name}/jobs/{id}/start | Mark job as started, ie: status = 'running' IronTitan.JobsApi | groupsNameJobsIdSuccessPost | POST /groups/{name}/jobs/{id}/success | Mark job as succeeded. IronTitan.JobsApi | groupsNameJobsIdTouchPost | POST /groups/{name}/jobs/{id}/touch | Extend job timeout. IronTitan.JobsApi | groupsNameJobsPost | POST /groups/{name}/jobs | Enqueue Job IronTitan.JobsApi | jobsGet | GET /jobs | Get next job. IronTitan.RunnerApi | groupsNameJobsIdErrorPost | POST /groups/{name}/jobs/{id}/error | Mark job as failed. IronTitan.RunnerApi | groupsNameJobsIdStartPost | POST /groups/{name}/jobs/{id}/start | Mark job as started, ie: status = 'running' IronTitan.RunnerApi | groupsNameJobsIdSuccessPost | 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.