interface Illuminate / Contracts / Queue / Job
You are viewing an older version of the documentation. For the latest, please visit master documentation.

Job

Methods

public

uuid ( ) : string|null

Get the UUID of the job.

public

getJobId ( ) : string

Get the job identifier.

public

payload ( ) : array

Get the decoded body of the job.

public

fire ( ) : void

Fire the job.

public

release ( $delay ) : void

Release the job back into the queue.

Parameters

  • $delay int
public

isReleased ( ) : bool

Determine if the job was released back into the queue.

public

delete ( ) : void

Delete the job from the queue.

public

isDeleted ( ) : bool

Determine if the job has been deleted.

public

isDeletedOrReleased ( ) : bool

Determine if the job has been deleted or released.

public

attempts ( ) : int

Get the number of times the job has been attempted.

public

hasFailed ( ) : bool

Determine if the job has been marked as a failure.

public

markAsFailed ( ) : void

Mark the job as "failed".

public

fail ( $e ) : void

Delete the job, call the "failed" method, and raise the failed job event.

Parameters

public

maxTries ( ) : int|null

Get the number of times to attempt a job.

public

maxExceptions ( ) : int|null

Get the maximum number of exceptions allowed, regardless of attempts.

public

timeout ( ) : int|null

Get the number of seconds the job can run.

public

retryUntil ( ) : int|null

Get the timestamp indicating when the job should timeout.

public

getName ( ) : string

Get the name of the queued job class.

public

resolveName ( ) : string

Get the resolved name of the queued job class.

public

getConnectionName ( ) : string

Get the name of the connection the job belongs to.

public

getQueue ( ) : string

Get the name of the queue the job belongs to.

public

getRawBody ( ) : string

Get the raw body string for the job.