Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

titan-api

treeder30.2.5

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

readme

titan-api

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

  • API verion: 0.2.5
  • Package version: 0.2.5
  • Build date: 2016-03-30T21:17:01.448Z
  • 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 titan-api --save

git

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

npm install YOUR_USERNAME/titan-api --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 TitanApi = require('titan-api');

var api = new TitanApi.CoreApi()

var id = "id_example"; // {String} Job id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.jobIdDelete(id, callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
TitanApi.CoreApi jobIdDelete DELETE /job/{id} Delete the job.
TitanApi.CoreApi jobIdGet GET /job/{id} Gets job by id
TitanApi.CoreApi jobsConsumeGet GET /jobs/consume Get next job.
TitanApi.CoreApi jobsPost POST /jobs Enqueue Job
TitanApi.ImagesApi imageIdGet GET /image/{id} Get information for image id.
TitanApi.ImagesApi imagesGet GET /images Get all image names.
TitanApi.JobsApi jobIdCancelPost POST /job/{id}/cancel Cancel a job.
TitanApi.JobsApi jobIdDelete DELETE /job/{id} Delete the job.
TitanApi.JobsApi jobIdFailPost POST /job/{id}/fail Mark job as failed.
TitanApi.JobsApi jobIdGet GET /job/{id} Gets job by id
TitanApi.JobsApi jobIdLogGet GET /job/{id}/log Get the log of a completed job.
TitanApi.JobsApi jobIdRetryPost POST /job/{id}/retry Retry a job.
TitanApi.JobsApi jobIdSuccessPost POST /job/{id}/success Mark job as succeeded.
TitanApi.JobsApi jobIdTouchPost POST /job/{id}/touch Extend job timeout.
TitanApi.JobsApi jobsConsumeGet GET /jobs/consume Get next job.
TitanApi.JobsApi jobsGet GET /jobs Peek at list of jobs.
TitanApi.JobsApi jobsPost POST /jobs Enqueue Job

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.