SqsJob

класс SqsJob расширяет Job и реализует Job (Просмотреть исходный код)

Трейты

Свойства

защищённое смешанное	$instance	Экземпляр обработчика задания.	из Job
защищённое Container	$container	Экземпляр контейнера IoC.	из Job
защищённое логическое значение	$deleted	Указывает, было ли задание удалено.	из Job
защищённое логическое значение	$released	Указывает, было ли задание освобождено.	из Job
защищённое логическое значение	$failed	Указывает, потерпело ли задание неудачу.	из Job
защищённая строка	$connectionName	Имя подключения, к которому относится задание.	из Job
защищённая строка	$queue	Имя очереди, к которой относится задание.	из Job
защищённое SqsClient	$sqs	Экземпляр клиента Amazon SQS.
защищённый массив	$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()

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

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)

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

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

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.

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

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

string getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

Вернуть задачу обратно в очередь.

Parameters

int

$delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

bool

bool hasFailed()

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

Return Value

bool

void markAsFailed()

Пометить задачу как "ошибка" (failed).

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

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null timeoutAt()

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

Return Value

int|null

string getName()

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

Return Value

string

string resolveName()

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

Разрешает имя "упакованных" задач, таких как обработчики на основе классов.

Return Value

string

string getConnectionName()

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

Return Value

string

string getQueue()

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

Return Value

string

Контейнер getContainer()

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

Значение возвращаемого значения

Контейнер

void __construct(Контейнер $container, SqsClient $sqs, array $job, string $connectionName, string $queue)

Создать новый экземпляр задания.

Параметры

Контейнер	$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/6.x/Illuminate/Queue/Jobs/SqsJob.html