Spec-Zone.ru › Laravel 5.8

Задание

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

Методы

строка 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

void release(int $delay = 0)

Вернуть задание обратно в очередь.

Принимает задержку, заданную в секундах.

Параметры

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 timeout()

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

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

int|null

int|null timeoutAt()

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

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

int|null

строка getName()

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

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

строка

строка resolveName()

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

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

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

строка

строка getConnectionName()

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

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

строка

string getQueue()

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

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

string

string getRawBody()

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

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

string

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

Spec-Zone.ru

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