SqsJob
класс SqsJob расширяет Job реализует Job (View source)
Черты
| InteractsWithTime |
Свойства
| 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)
Получить количество секунд до заданной даты и времени. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени UNIX "доступно в". | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime()
Получить текущее системное время в виде метки времени UNIX. | из 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)
Получить количество секунд до заданной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени UNIX "доступно в".
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в виде метки времени UNIX.
string getJobId()
Получить идентификатор задания.
string getRawBody()
Получить необработанную строку тела для задания.
string|null uuid()
Получить UUID задания.
void fire()
Запустить задание.
void delete()
Удалить задание из очереди.
bool isDeleted()
Определить, было ли удалено задание.
void release(int $delay = 0)
Вернуть задание в очередь через (n) секунд.
bool isReleased()
Определить, было ли задание возвращено в очередь.
bool isDeletedOrReleased()
Определить, было ли задание удалено или возвращено.
bool hasFailed()
Определить, было ли задание помечено как неудачное.
void markAsFailed()
Пометить задание как "неудачное".
void fail(Throwable|null $e = null)
Удалить задание, вызвать метод "failed" и поднять событие неудачного задания.
protected void failed(Throwable|null $e)
Обработать исключение, вызвавшее сбой задания.
protected mixed resolve(string $class)
Разрешить заданный класс.
mixed getResolvedJob()
Получить разрешенный экземпляр обработчика заданий.
array payload()
Получить декодированное тело задания.
int|null maxTries()
Получить количество попыток выполнения задания.
int|null maxExceptions()
Получить количество попыток выполнения задания после исключения.
bool shouldFailOnTimeout()
Определить, должно ли задание завершиться неудачей при истечении времени ожидания.
int|int[]|null backoff()
Количество секунд ожидания перед повторной попыткой выполнения задания, которое столкнулось с неперехваченным исключением.
int|null timeout()
Получить количество секунд, в течение которых может выполняться задание.
int|null retryUntil()
Получить метку времени, указывающую, когда задача должна завершиться по таймауту.
string getName()
Получить имя класса задачи в очереди.
string resolveName()
Получить решенное имя класса задачи в очереди.
Разрешает имя «обернутых» задач, таких как обработчики на основе классов.
string getConnectionName()
Получить имя соединения, к которому принадлежит задача.
string getQueue()
Получить имя очереди, к которой принадлежит задача.
Container getContainer()
Получить экземпляр контейнера сервисов.
void __construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)
Создать новый экземпляр задачи.
int attempts()
Получить количество попыток выполнения задачи.
SqsClient getSqs()
Получить основной экземпляр клиента SQS.
array getSqsJob()
Получить необработанную задачу SQS.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/Jobs/SqsJob.html
