Spec-Zone.ru › Laravel 10

Задача

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

Методы

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

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

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

строка

массив payload()

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

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

массив

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/10.x/Illuminate/Contracts/Queue/Job.html

Spec-Zone.ru

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