W3cubDocs

/Laravel 8

Job

interface Job (View source)

Methods

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.

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 resolved name of the queued job class.

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.

Details

string|null uuid()

Get the UUID of the job.

Return Value

string|null

string getJobId()

Get the job identifier.

Return Value

string

array payload()

Get the decoded body of the job.

Return Value

array

void fire()

Fire the job.

Return Value

void

void release(int $delay = 0)

Release the job back into the queue.

Accepts a delay specified in seconds.

Parameters

int

$delay

Return Value

void

bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

void delete()

Delete the job from the queue.

Return Value

void

bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

int attempts()

Get the number of times the job has been attempted.

Return Value

int

bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

void markAsFailed()

Mark the job as "failed".

Return Value

void

void fail(Throwable|null $e = null)

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

Parameters

Throwable|null

Return Value

void

int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

int|null maxExceptions()

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

Return Value

int|null

int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

int|null retryUntil()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

string getName()

Get the name of the queued job class.

Return Value

string

string resolveName()

Get the resolved name of the queued job class.

Resolves the name of "wrapped" jobs such as class-based handlers.

Return Value

string

string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

string getRawBody()

Get the raw body string for the job.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Contracts/Queue/Job.html