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 | $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() Получить строку тела задачи в сыром виде. | |
| 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 | failed(Exception $e) Обработать исключение, приведшее к завершению задачи с ошибкой. | из Job |
| mixed | resolve(string $class) Разрешить заданный класс. | из Job |
| array | payload() Получить декодированное тело задачи. | из Job |
| int|null | maxTries() Получить количество попыток выполнения задачи. | из 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 в сыром виде. |
Подробности
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()
Получить строку исходного тела для задачи.
void fire()
Запустить задачу.
void delete()
Удалить задачу из очереди.
bool isDeleted()
Определить, была ли задача удалена.
void release(int $delay = 0)
Возвратить задачу обратно в очередь.
bool isReleased()
Определить, была ли задача возвращена обратно в очередь.
bool isDeletedOrReleased()
Определить, была ли задача удалена или возвращена в очередь.
bool hasFailed()
Определить, была ли задача помечена как не выполненная.
void markAsFailed()
Пометить задачу как «не выполненная».
void failed(Exception $e)
Обработать исключение, которое привело к тому, что задача не выполнилась.
protected mixed resolve(string $class)
Разрешить указанный класс.
array payload()
Получить декодированное тело задачи.
int|null maxTries()
Получить количество попыток выполнения задачи.
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.7/Illuminate/Queue/Jobs/SqsJob.html
