lib/dkron-rb/api/jobs_api.rb in dkron-rb-0.11.2 vs lib/dkron-rb/api/jobs_api.rb in dkron-rb-1.0.0
- old
+ new
@@ -1,52 +1,49 @@
=begin
#Dkron REST API
#You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port `8080` for API requests. All examples in this section assume that you've found a running leader at `localhost:8080`. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port `8080` by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the `pretty=true` param to format the response.
-OpenAPI spec version: 0.11.2
+OpenAPI spec version: 1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.2
=end
-require "uri"
+require 'uri'
module Dkron
class JobsApi
attr_accessor :api_client
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
-
- #
# Create or updates a new job.
# @param body Updated job object
# @param [Hash] opts the optional parameters
# @return [Job]
def create_or_update_job(body, opts = {})
data, _status_code, _headers = create_or_update_job_with_http_info(body, opts)
- return data
+ data
end
- #
# Create or updates a new job.
# @param body Updated job object
# @param [Hash] opts the optional parameters
# @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
def create_or_update_job_with_http_info(body, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: JobsApi.create_or_update_job ..."
+ @api_client.config.logger.debug 'Calling API: JobsApi.create_or_update_job ...'
end
# verify the required parameter 'body' is set
if @api_client.config.client_side_validation && body.nil?
fail ArgumentError, "Missing the required parameter 'body' when calling JobsApi.create_or_update_job"
end
# resource path
- local_var_path = "/jobs"
+ local_var_path = '/jobs'
# query parameters
query_params = {}
# header parameters
@@ -72,36 +69,33 @@
if @api_client.config.debugging
@api_client.config.logger.debug "API called: JobsApi#create_or_update_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
-
- #
# Delete a job.
# @param job_name The job that needs to be deleted.
# @param [Hash] opts the optional parameters
# @return [Job]
def delete_job(job_name, opts = {})
data, _status_code, _headers = delete_job_with_http_info(job_name, opts)
- return data
+ data
end
- #
# Delete a job.
# @param job_name The job that needs to be deleted.
# @param [Hash] opts the optional parameters
# @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
def delete_job_with_http_info(job_name, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: JobsApi.delete_job ..."
+ @api_client.config.logger.debug 'Calling API: JobsApi.delete_job ...'
end
# verify the required parameter 'job_name' is set
if @api_client.config.client_side_validation && job_name.nil?
fail ArgumentError, "Missing the required parameter 'job_name' when calling JobsApi.delete_job"
end
# resource path
- local_var_path = "/jobs/{job_name}".sub('{' + 'job_name' + '}', job_name.to_s)
+ local_var_path = '/jobs/{job_name}'.sub('{' + 'job_name' + '}', job_name.to_s)
# query parameters
query_params = {}
# header parameters
@@ -127,33 +121,33 @@
if @api_client.config.debugging
@api_client.config.logger.debug "API called: JobsApi#delete_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
-
- #
# List jobs.
# @param [Hash] opts the optional parameters
+ # @option opts [Array<String>] :tags Filter jobs by tags
# @return [Array<Job>]
def get_jobs(opts = {})
data, _status_code, _headers = get_jobs_with_http_info(opts)
- return data
+ data
end
- #
# List jobs.
# @param [Hash] opts the optional parameters
+ # @option opts [Array<String>] :tags Filter jobs by tags
# @return [Array<(Array<Job>, Fixnum, Hash)>] Array<Job> data, response status code and response headers
def get_jobs_with_http_info(opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: JobsApi.get_jobs ..."
+ @api_client.config.logger.debug 'Calling API: JobsApi.get_jobs ...'
end
# resource path
- local_var_path = "/jobs"
+ local_var_path = '/jobs'
# query parameters
query_params = {}
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -176,36 +170,33 @@
if @api_client.config.debugging
@api_client.config.logger.debug "API called: JobsApi#get_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
-
- #
# Executes a job.
# @param job_name The job that needs to be run.
# @param [Hash] opts the optional parameters
# @return [Job]
def run_job(job_name, opts = {})
data, _status_code, _headers = run_job_with_http_info(job_name, opts)
- return data
+ data
end
- #
# Executes a job.
# @param job_name The job that needs to be run.
# @param [Hash] opts the optional parameters
# @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
def run_job_with_http_info(job_name, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: JobsApi.run_job ..."
+ @api_client.config.logger.debug 'Calling API: JobsApi.run_job ...'
end
# verify the required parameter 'job_name' is set
if @api_client.config.client_side_validation && job_name.nil?
fail ArgumentError, "Missing the required parameter 'job_name' when calling JobsApi.run_job"
end
# resource path
- local_var_path = "/jobs/{job_name}".sub('{' + 'job_name' + '}', job_name.to_s)
+ local_var_path = '/jobs/{job_name}'.sub('{' + 'job_name' + '}', job_name.to_s)
# query parameters
query_params = {}
# header parameters
@@ -231,36 +222,33 @@
if @api_client.config.debugging
@api_client.config.logger.debug "API called: JobsApi#run_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
-
- #
# Show a job.
# @param job_name The job that needs to be fetched.
# @param [Hash] opts the optional parameters
# @return [Job]
def show_job_by_name(job_name, opts = {})
data, _status_code, _headers = show_job_by_name_with_http_info(job_name, opts)
- return data
+ data
end
- #
# Show a job.
# @param job_name The job that needs to be fetched.
# @param [Hash] opts the optional parameters
# @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
def show_job_by_name_with_http_info(job_name, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: JobsApi.show_job_by_name ..."
+ @api_client.config.logger.debug 'Calling API: JobsApi.show_job_by_name ...'
end
# verify the required parameter 'job_name' is set
if @api_client.config.client_side_validation && job_name.nil?
fail ArgumentError, "Missing the required parameter 'job_name' when calling JobsApi.show_job_by_name"
end
# resource path
- local_var_path = "/jobs/{job_name}".sub('{' + 'job_name' + '}', job_name.to_s)
+ local_var_path = '/jobs/{job_name}'.sub('{' + 'job_name' + '}', job_name.to_s)
# query parameters
query_params = {}
# header parameters
@@ -283,9 +271,61 @@
:body => post_body,
:auth_names => auth_names,
:return_type => 'Job')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: JobsApi#show_job_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ return data, status_code, headers
+ end
+ # Toggle a job.
+ # @param job_name The job that needs to be toggled.
+ # @param [Hash] opts the optional parameters
+ # @return [Job]
+ def toggle_job(job_name, opts = {})
+ data, _status_code, _headers = toggle_job_with_http_info(job_name, opts)
+ data
+ end
+
+ # Toggle a job.
+ # @param job_name The job that needs to be toggled.
+ # @param [Hash] opts the optional parameters
+ # @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
+ def toggle_job_with_http_info(job_name, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.toggle_job ...'
+ end
+ # verify the required parameter 'job_name' is set
+ if @api_client.config.client_side_validation && job_name.nil?
+ fail ArgumentError, "Missing the required parameter 'job_name' when calling JobsApi.toggle_job"
+ end
+ # resource path
+ local_var_path = '/jobs/{job_name}/toggle'.sub('{' + 'job_name' + '}', job_name.to_s)
+
+ # query parameters
+ query_params = {}
+
+ # header parameters
+ header_params = {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+ # form parameters
+ form_params = {}
+
+ # http body (model)
+ post_body = nil
+ auth_names = []
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => 'Job')
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#toggle_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
end
end