Class: PerfectQueue::Task

Inherits:
Object
  • Object
show all
Includes:
Model
Defined in:
lib/perfectqueue/task.rb

Direct Known Subclasses

TaskWithMetadata

Instance Attribute Summary collapse

Attributes included from Model

#client

Instance Method Summary collapse

Methods included from Model

#config

Constructor Details

#initialize(client, key) ⇒ Task

Returns a new instance of Task.



23
24
25
26
 
# File 'lib/perfectqueue/task.rb', line 23

def initialize(client, key)
  super(client)
  @key = key
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



28
29
30
 
# File 'lib/perfectqueue/task.rb', line 28

def key
  @key
end

Instance Method Details

#cancel_request!(options = {}) ⇒ Object 



30
31
32
 
# File 'lib/perfectqueue/task.rb', line 30

def cancel_request!(options={})
  @client.cancel_request(@key, options)
end

#exists?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
46
47
 
# File 'lib/perfectqueue/task.rb', line 42

def exists?(options={})
  metadata(options)
  true
rescue NotFoundError
  false
end

#force_finish!(options = {}) ⇒ Object 



34
35
36
 
# File 'lib/perfectqueue/task.rb', line 34

def force_finish!(options={})
  @client.force_finish(@key, options)
end

#inspect ⇒ Object 



53
54
55
 
# File 'lib/perfectqueue/task.rb', line 53

def inspect
  "#<#{self.class} @key=#{@key.inspect}>"
end

#metadata(options = {}) ⇒ Object 



38
39
40
 
# File 'lib/perfectqueue/task.rb', line 38

def metadata(options={})
  @client.get_task_metadata(@key, options)
end

#preempt(options = {}) ⇒ Object 



49
50
51
 
# File 'lib/perfectqueue/task.rb', line 49

def preempt(options={})
  @client.preempt(@key, options)
end