Spec-Zone.ru › Laravel 9

Задание

интерфейс Задание (Просмотреть исходный код)

Методы

строка|null uuid()

Получить UUID задания.

строка getJobId()

Получить идентификатор задания.

массив payload()

Получить декодированное тело задания.

void fire()

Выполнить задание.

void release(int $delay = 0)

Вернуть задание обратно в очередь через (n) секунд.

bool isReleased()

Определить, было ли задание возвращено обратно в очередь.

void delete()

Удалить задание из очереди.

bool isDeleted()

Определить, было ли задание удалено.

bool isDeletedOrReleased()

Определить, было ли задание удалено или возвращено в очередь.

int attempts()

Получить количество попыток выполнения задания.

bool hasFailed()

Определить, было ли задание помечено как не выполненное.

void markAsFailed()

Пометить задание как "не выполненное".

void fail(Throwable|null $e = null)

Удалить задание, вызвать метод "failed" и поднять событие о невыполненном задании.

int|null maxTries()

Получить количество попыток выполнения задания.

int|null maxExceptions()

Получить максимальное количество допустимых исключений, независимо от попыток.

int|null timeout()

Получить количество секунд, в течение которых задание может выполняться.

int|null retryUntil()

Получить метку времени, указывающую, когда задание должно истечь.

строка getName()

Получить имя класса очереди задания.

строка resolveName()

Получить разрешенное имя класса очереди задания.

строка getConnectionName()

Получить имя подключения, к которому относится задание.

строка getQueue()

Получить имя очереди, к которой относится задание.

строка getRawBody()

Получить строку тела задания в исходном виде.

Подробности

строка|null uuid()

Получить UUID задания.

Значение возврата

строка|null

строка getJobId()

Получить идентификатор задания.

Значение возврата

строка

array payload()

Получить декодированное тело задания.

Значение возвращаемого значения

array

void fire()

Запустить задание.

Значение возвращаемого значения

void

void release(int $delay = 0)

Возвратить задание обратно в очередь через (n) секунд.

Параметры

int $delay

Значение возвращаемого значения

void

bool isReleased()

Определить, было ли задание возвращено в очередь.

Значение возвращаемого значения

bool

void delete()

Удалить задание из очереди.

Значение возвращаемого значения

void

bool isDeleted()

Определить, было ли задание удалено.

Значение возвращаемого значения

bool

bool isDeletedOrReleased()

Определить, было ли задание удалено или возвращено в очередь.

Значение возвращаемого значения

bool

int attempts()

Получить количество попыток выполнения задания.

Значение возвращаемого значения

int

bool hasFailed()

Определить, было ли задание помечено как неудачное.

Значение возвращаемого значения

bool

void markAsFailed()

Пометить задание как «неудачное».

Значение возвращаемого значения

void

void fail(Throwable|null $e = null)

Удалить задание, вызвать метод «failed» и повысить событие неудачного выполнения задания.

Параметры

Throwable|null $e

Значение возвращаемого значения

void

int|null maxTries()

Получить количество попыток выполнения задания.

Значение возвращаемого значения

int|null

int|null maxExceptions()

Получить максимальное количество допустимых исключений, независимо от попыток.

Значение возвращаемого значения

int|null

int|null timeout()

Получить количество секунд, в течение которых задание может выполняться.

Значение возвращаемого значения

int|null

int|null retryUntil()

Получить метку времени, указывающую, когда задание должно истечь.

Значение возвращаемого значения

int|null

string getName()

Получить имя класса очереди задач.

Возвращаемое значение

string

string resolveName()

Получить разрешенное имя класса очереди задач.

Разрешает имя «обернутых» задач, таких как обработчики на основе классов.

Возвращаемое значение

string

string getConnectionName()

Получить имя подключения, к которому относится задача.

Возвращаемое значение

string

string getQueue()

Получить имя очереди, к которой относится задача.

Возвращаемое значение

string

string getRawBody()

Получить исходное строковое тело задачи.

Возвращаемое значение

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API