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)

Удалить задание, вызвать метод «не выполнено», и поднять событие не выполненного задания.

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

int|null

delaySeconds()

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

from Job

int|null

timeout()

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

from Job

int|null

timeoutAt()

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

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 timestamp) для «доступности».

Параметры

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)

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

Параметры

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

int|null delaySeconds()

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

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

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

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

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