SqsJob

класс SqsJob расширяет Job и реализует Job (Просмотреть исходный код)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задания.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, было ли задание удалено.	из Job
protected bool	$released	Указывает, было ли задание освобождено.	из Job
protected bool	$failed	Указывает, потерпел ли провал задание.	из Job
protected string	$connectionName	Имя подключения, к которому относится задание.	из Job
protected string	$queue	Имя очереди, к которой относится задание.	из Job
protected SqsClient	$sqs	Экземпляр клиента Amazon SQS.
protected array	$job	Экземпляр задания Amazon SQS.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени "available at" в формате UNIX timestamp.

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

из InteractsWithTime

int

currentTime()

Получить текущее системное время в формате UNIX timestamp.

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

из Job

void

fire()

Запустить задачу.

из Job

void

delete()

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

bool

isDeleted()

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

из Job

void

release(int $delay = 0)

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

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

Пометить задачу как завершившуюся ошибкой.

из Job

void

fail(Throwable|null $e = null)

Удалить задачу, вызвать метод "failed" и поднять событие завершения задачи с ошибкой.

из Job

void

failed(Throwable|null $e)

Обработать исключение, которое привело к завершению задачи с ошибкой.

из Job

mixed

resolve(string $class)

Разрешить указанный класс.

из Job

mixed

getResolvedJob()

Получить экземпляр обработчика разрешенной задачи.

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

maxExceptions()

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

из Job

bool

shouldFailOnTimeout()

Определить, должна ли задача завершиться ошибкой при истечении времени ожидания.

из Job

int|int[]|null

backoff()

Количество секунд ожидания перед повторной попыткой выполнения задачи, столкнувшейся с непредвиденным исключением.

из Job

int|null

timeout()

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

из Job

int|null

retryUntil()

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

из Job

string

getName()

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

из Job

string

resolveName()

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

из Job

string

getConnectionName()

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

из Job

string

getQueue()

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

из Job

Container

getContainer()

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

из Job

void

__construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

int

attempts()

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

SqsClient

getSqs()

Получить базовый экземпляр клиента SQS.

array

getSqsJob()

Получить базовый сырой объект задачи SQS.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени UNIX "доступно в" (available at).

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

string getJobId()

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

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

string

string getRawBody()

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

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

string

string|null uuid()

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

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

string|null

void fire()

Запустить задачу.

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

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

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

void

void fail(Throwable|null $e = null)

Удалить задачу, вызвать метод "failed", и сгенерировать событие "failed job".

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

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

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

Разрешить указанный класс.

Параметры

string

$class

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

mixed

mixed getResolvedJob()

Получить экземпляр обработчика решенной задачи.

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

bool shouldFailOnTimeout()

Определить, должна ли задача завершиться ошибкой при истечении времени ожидания.

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

bool

int|int[]|null backoff()

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

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

int|int[]|null

int|null timeout()

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

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

int|null

int|null retryUntil()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

void __construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

Параметры

Container	$container
SqsClient	$sqs
array	$job
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

SqsClient getSqs()

Получить базовый экземпляр клиента SQS.

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

SqsClient

array getSqsJob()

Получить исходную сырую задачу SQS.

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

array

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