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.

from InteractsWithTime

int

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

Получить отметку времени «доступно в» в формате UNIX timestamp.

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

from Job

void

fire()

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

from Job

void

delete()

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

bool

isDeleted()

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

from Job

void

release(int $delay = 0)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

Пометить задание как «завершившееся с ошибкой».

from Job

void

fail(Throwable|null $e = null)

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

from Job

void

failed(Throwable|null $e)

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

from Job

mixed

resolve(string $class)

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

from Job

mixed

getResolvedJob()

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

maxExceptions()

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

from Job

bool

shouldFailOnTimeout()

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

from Job

int|null

backoff()

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

from Job

int|null

timeout()

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

from Job

int|null

retryUntil()

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

from Job

string

getName()

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

from Job

string

resolveName()

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

from Job

string

getConnectionName()

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

from Job

string

getQueue()

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

from Job

Container

getContainer()

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

from 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)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить метку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

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)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

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

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

void

void fail(Throwable|null $e = null)

Удалить задачу, вызвать метод «ошибка» и сгенерировать событие об ошибочной задаче.

Параметры

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|null backoff()

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

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

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/8.x/Illuminate/Queue/Jobs/SqsJob.html