Задача
интерфейс Задача (Просмотреть исходный код)
Методы
| строка | getJobId() Получить идентификатор задачи. | |
| массив | payload() Получить декодированное тело задачи. | |
| void | fire() Запустить задачу. | |
| void | release(int $delay = 0) Вернуть задачу обратно в очередь. | |
| 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 | timeout() Получить количество секунд, в течение которых задача может выполняться. | |
| int|null | timeoutAt() Получить метку времени, указывающую, когда задача должна истечь. | |
| строка | getName() Получить имя класса задачи в очереди. | |
| строка | resolveName() Получить разрешённое имя класса задачи в очереди. Разрешает имя «обёрнутых» задач, таких как обработчики на основе классов. | |
| строка | getConnectionName() Получить имя подключения, к которому принадлежит задача. | |
| строка | getQueue() Получить имя очереди, к которой принадлежит задача. | |
| строка | getRawBody() Получить сырое тело строки задачи. |
Подробности
строка getJobId()
Получить идентификатор задачи.
массив payload()
Получить декодированное тело задачи.
void fire()
Запустить задачу.
void release(int $delay = 0)
Вернуть задачу обратно в очередь.
Принимает задержку, указанную в секундах.
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 timeout()
Получить количество секунд, в течение которых задача может выполняться.
int|null timeoutAt()
Получить метку времени, указывающую, когда задача должна истечь.
строка getName()
Получить имя класса задачи в очереди.
строка resolveName()
Получить разрешённое имя класса задачи в очереди.
Разрешает имя «обёрнутых» задач, таких как обработчики на основе классов.
строка getConnectionName()
Получить имя подключения, к которому принадлежит задача.
string getQueue()
Получить имя очереди, к которой принадлежит задание.
string getRawBody()
Получить исходную строку тела задания.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Contracts/Queue/Job.html
