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.

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время выполнения для удобного восприятия человеком.

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)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

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

from Job

void

fail(Throwable|null $e = null)

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

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Вычислить и отформатировать общее время выполнения для отображения пользователю.

Parameters

float	$startTime
float	$endTime

Return Value

string

string getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

string|null uuid()

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

Return Value

string|null

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

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

Parameters

int

$delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

bool

bool hasFailed()

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

Return Value

bool

void markAsFailed()

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

Return Value

void

void fail(Throwable|null $e = null)

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

Parameters

Throwable|null

Return Value

void

protected void failed(Throwable|null $e)

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

Parameters

Throwable|null

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

mixed getResolvedJob()

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

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null maxExceptions()

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

Return Value

int|null

bool shouldFailOnTimeout()

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

Return Value

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