SqsJob
class SqsJob extends Job implements 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) Получить количество секунд до указанной даты DateTime. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить метку времени в формате UNIX «доступно в». | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime() Получить текущее системное время в формате UNIX timestamp. | из InteractsWithTime |
| string | getJobId() Получить идентификатор задания. | |
| string | getRawBody() Получить исходную строку тела задания. | |
| void | fire() Запустить задание. | из Job |
| void | delete() Удалить задание из очереди. | |
| bool | isDeleted() Определить, было ли задание удалено. | из Job |
| void | release(int $delay = 0) Вернуть задание обратно в очередь. | |
| 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 |
| array | payload() Получить декодированное тело задания. | из Job |
| int|null | maxTries() Получить количество попыток выполнения задания. | из Job |
| int|null | delaySeconds() Получить количество секунд задержки для повторной попытки не удавшегося задания. | из Job |
| int|null | timeout() Получить количество секунд, в течение которых задание может выполняться. | из Job |
| int|null | timeoutAt() Получить метку времени, указывающую, когда задание должно истечь. | из 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. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты DateTime.
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()
Получить исходную строку тела задания.
void fire()
Запустить задание.
void delete()
Удалить задание из очереди.
bool isDeleted()
Определить, было ли задание удалено.
void release(int $delay = 0)
Вернуть задание в очередь.
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)
Разрешить указанный класс.
array payload()
Получить декодированное тело задания.
int|null maxTries()
Получить количество попыток выполнения задания.
int|null delaySeconds()
Получить количество секунд задержки проваленного задания перед повторной попыткой.
int|null timeout()
Получить количество секунд, в течение которых задание может выполняться.
int|null timeoutAt()
Получить отметку времени, указывающую, когда задание должно истечь.
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/5.8/Illuminate/Queue/Jobs/SqsJob.html
