allq_client

Allq - the Ruby gem for the AllQ

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build allq_client.gemspec

Then either install the gem locally:

gem install ./allq_client-1.0.0.gem

(for development, run gem install --dev ./allq_client-1.0.0.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 'allq_client', '~> 1.0.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 'allq_client', :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 'allq_client'

api_instance = Allq::ActionsApi.new

job_id = "job_id_example" # String | Job ID


begin
  #Bury
  result = api_instance.bury_put(job_id)
  p result
rescue Allq::ApiError => e
  puts "Exception when calling ActionsApi->bury_put: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:8090

Class	Method	HTTP request	Description
Allq::ActionsApi	bury_put	PUT /bury	Bury
Allq::ActionsApi	job_delete	DELETE /job	Delete
Allq::ActionsApi	job_get	GET /job	Job
Allq::ActionsApi	job_post	POST /job	Job
Allq::ActionsApi	parent_job_post	POST /parent_job	Parent Job
Allq::ActionsApi	peek_get	GET /peek	Peek
Allq::ActionsApi	release_put	PUT /release	Release
Allq::ActionsApi	set_children_started_put	PUT /set_children_started	Set Children Started
Allq::ActionsApi	throttle_post	POST /throttle	Throttle
Allq::ActionsApi	touch_put	PUT /touch	Touch
Allq::ActionsApi	tube_delete	DELETE /tube	Clear Tube
Allq::AdminApi	stats_get	GET /stats	Stats
Allq::AdminApi	update_servers_put	PUT /update_servers	Reset Server Urls

Documentation for Models

• Allq::BasicPayload
• Allq::BasicResponse
• Allq::JobRef
• Allq::JobResponse
• Allq::NewJob
• Allq::NewParentJob
• Allq::StatsInfo
• Allq::StatsResults
• Allq::StatsTube
• Allq::Throttle
• Allq::TubeRef

Documentation for Authorization

All endpoints do not require authorization.