Class: Sidekiq::Job
- Inherits:
-
Object
- Object
- Sidekiq::Job
- Defined in:
- lib/sidekiq/api.rb
Overview
Encapsulates a pending job within a Sidekiq queue or sorted set.
The job should be considered immutable but may be removed from the queue via Job#delete.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#item ⇒ Object
readonly
Returns the value of attribute item.
Instance Method Summary collapse
- #[](name) ⇒ Object
- #args ⇒ Object
-
#delete ⇒ Object
Remove this job from the queue.
-
#initialize(item, queue_name = nil) ⇒ Job
constructor
A new instance of Job.
- #jid ⇒ Object
- #klass ⇒ Object
- #queue ⇒ Object
Constructor Details
Instance Attribute Details
#item ⇒ Object (readonly)
Returns the value of attribute item.
158 159 160 |
# File 'lib/sidekiq/api.rb', line 158 def item @item end |
Instance Method Details
#[](name) ⇒ Object
191 192 193 |
# File 'lib/sidekiq/api.rb', line 191 def [](name) @item.send(:[], name) end |
#args ⇒ Object
170 171 172 |
# File 'lib/sidekiq/api.rb', line 170 def args @item['args'] end |
#delete ⇒ Object
Remove this job from the queue.
184 185 186 187 188 189 |
# File 'lib/sidekiq/api.rb', line 184 def delete count = Sidekiq.redis do |conn| conn.lrem("queue:#{@queue}", 0, @value) end count != 0 end |
#jid ⇒ Object
174 175 176 |
# File 'lib/sidekiq/api.rb', line 174 def jid @item['jid'] end |
#klass ⇒ Object
166 167 168 |
# File 'lib/sidekiq/api.rb', line 166 def klass @item['class'] end |
#queue ⇒ Object
178 179 180 |
# File 'lib/sidekiq/api.rb', line 178 def queue @queue end |