Module: Selligent::Client::Tasks

Included in:
Selligent::Client
Defined in:
lib/selligent/client/tasks.rb

Overview

Implements the task endpoints

/organizations/:organization/tasks/*

Instance Method Summary collapse

Instance Method Details

#disable_task(name) ⇒ Object

Disable a task

Parameters:

  • name (String) —

    The task name



37
38
39
 
# File 'lib/selligent/client/tasks.rb', line 37

def disable_task(name)
  post "#{base_url}/tasks/#{name}/actions/disable"
end

#enable_task(name) ⇒ Object

Enable a task

Parameters:

  • name (String) —

    The task name



44
45
46
 
# File 'lib/selligent/client/tasks.rb', line 44

def enable_task(name)
  post "#{base_url}/tasks/#{name}/actions/enable"
end

#run_task(name) ⇒ Object

Run a task

Parameters:

  • name (String) —

    The task name



51
52
53
 
# File 'lib/selligent/client/tasks.rb', line 51

def run_task(name)
  post "#{base_url}/tasks/#{name}/actions/run"
end

#task(name) ⇒ Object

Get task details by name

Parameters:

  • name (String) —

    The task name



23
24
25
 
# File 'lib/selligent/client/tasks.rb', line 23

def task(name)
  get "#{base_url}/tasks/#{name}"
end

#task_actions(task_name) ⇒ Object

Get task-actions by task name

Parameters:

  • task_name (String) —

    The task name



30
31
32
 
# File 'lib/selligent/client/tasks.rb', line 30

def task_actions(task_name)
  get "#{base_url}/tasks/#{task_name}/actions"
end

#tasks(options = {}) ⇒ Object

Get a collection of tasks

Parameters:

  • options (Hash) (defaults to: {}) —

    Additional options

Options Hash (options):

  • :filter (String) —

    Filter by type

  • :search (String) —

    Search by name, description or tags

  • :skip (Integer) —

    Specify index to start form

  • :take (Integer) —

    Specify number of tasks to take



16
17
18
 
# File 'lib/selligent/client/tasks.rb', line 16

def tasks(options = {})
  get "#{base_url}/tasks", options
end