Job
interface Job (View source)
Methods
Get the UUID of the job.
Get the job identifier.
Get the decoded body of the job.
Fire the job.
Release the job back into the queue after (n) seconds.
Determine if the job was released back into the queue.
Delete the job from the queue.
Determine if the job has been deleted.
Determine if the job has been deleted or released.
Get the number of times the job has been attempted.
Determine if the job has been marked as a failure.
Mark the job as "failed".
Get the number of times to attempt a job.
Get the maximum number of exceptions allowed, regardless of attempts.
Get the number of seconds the job can run.
Get the timestamp indicating when the job should timeout.
Get the name of the queued job class.
Get the display name of the queued job class.
Get the class of the queued job.
Get the name of the connection the job belongs to.
Get the name of the queue the job belongs to.
Get the raw body string for the job.
Details
string|null
uuid()
Get the UUID of the job.
string
getJobId()
Get the job identifier.
array
payload()
Get the decoded body of the job.
void
fire()
Fire the job.
void
release(int $delay = 0)
Release the job back into the queue after (n) seconds.
bool
isReleased()
Determine if the job was released back into the queue.
void
delete()
Delete the job from the queue.
bool
isDeleted()
Determine if the job has been deleted.
bool
isDeletedOrReleased()
Determine if the job has been deleted or released.
int
attempts()
Get the number of times the job has been attempted.
bool
hasFailed()
Determine if the job has been marked as a failure.
void
markAsFailed()
Mark the job as "failed".
void
fail(Throwable|null $e = null)
Delete the job, call the "failed" method, and raise the failed job event.
int|null
maxTries()
Get the number of times to attempt a job.
int|null
maxExceptions()
Get the maximum number of exceptions allowed, regardless of attempts.
int|null
timeout()
Get the number of seconds the job can run.
int|null
retryUntil()
Get the timestamp indicating when the job should timeout.
string
getName()
Get the name of the queued job class.
string
resolveName()
Get the display name of the queued job class.
Resolves the name of "wrapped" jobs such as class-based handlers.
string
resolveQueuedJobClass()
Get the class of the queued job.
Resolves the class of "wrapped" jobs such as class-based handlers.
string
getConnectionName()
Get the name of the connection the job belongs to.
string
getQueue()
Get the name of the queue the job belongs to.
string
getRawBody()
Get the raw body string for the job.