SqsJob
class SqsJob extends Job implements Job (View source)
Traits
| InteractsWithTime |
Properties
| protected mixed | $instance | The job handler instance. | from Job |
| protected Container | $container | The IoC container instance. | from Job |
| protected bool | $deleted | Indicates if the job has been deleted. | from Job |
| protected bool | $released | Indicates if the job has been released. | from Job |
| protected bool | $failed | Indicates if the job has failed. | from Job |
| protected | $connectionName | The name of the connection the job belongs to. | from Job |
| protected string | $queue | The name of the queue the job belongs to. | from Job |
| protected SqsClient | $sqs | The Amazon SQS client instance. | |
| protected array | $job | The Amazon SQS job instance. |
Methods
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Get the number of seconds until the given DateTime. | from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Get the "available at" UNIX timestamp. | from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) If the given value is an interval, convert it to a DateTime instance. | from InteractsWithTime |
| int | currentTime() Get the current system time as a UNIX timestamp. | from InteractsWithTime |
| string | getJobId() Get the job identifier. | |
| string | getRawBody() Get the raw body string for the job. | |
| void | fire() Fire the job. | from Job |
| void | delete() Delete the job from the queue. | |
| bool | isDeleted() Determine if the job has been deleted. | from Job |
| void | release(int $delay = 0) Release the job back into the queue. | |
| bool | isReleased() Determine if the job was released back into the queue. | from Job |
| bool | isDeletedOrReleased() Determine if the job has been deleted or released. | from Job |
| bool | hasFailed() Determine if the job has been marked as a failure. | from Job |
| void | markAsFailed() Mark the job as "failed". | from Job |
| void | failed(Exception $e) Process an exception that caused the job to fail. | from Job |
| mixed | resolve(string $class) Resolve the given class. | from Job |
| array | payload() Get the decoded body of the job. | from Job |
| int|null | maxTries() Get the number of times to attempt a job. | from Job |
| int|null | timeout() Get the number of seconds the job can run. | from Job |
| int|null | timeoutAt() Get the timestamp indicating when the job should timeout. | from Job |
| string | getName() Get the name of the queued job class. | from Job |
| string | resolveName() Get the resolved name of the queued job class. | from Job |
| string | getConnectionName() Get the name of the connection the job belongs to. | from Job |
| string | getQueue() Get the name of the queue the job belongs to. | from Job |
| Container | getContainer() Get the service container instance. | from Job |
| void | __construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue) Create a new job instance. | |
| int | attempts() Get the number of times the job has been attempted. | |
| SqsClient | getSqs() Get the underlying SQS client instance. | |
| array | getSqsJob() Get the underlying raw SQS job. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int currentTime()
Get the current system time as a UNIX timestamp.
string getJobId()
Get the job identifier.
string getRawBody()
Get the raw body string for the job.
void fire()
Fire the job.
void delete()
Delete the job from the queue.
bool isDeleted()
Determine if the job has been deleted.
void release(int $delay = 0)
Release the job back into the queue.
bool isReleased()
Determine if the job was released back into the queue.
bool isDeletedOrReleased()
Determine if the job has been deleted or released.
bool hasFailed()
Determine if the job has been marked as a failure.
void markAsFailed()
Mark the job as "failed".
void failed(Exception $e)
Process an exception that caused the job to fail.
protected mixed resolve(string $class)
Resolve the given class.
array payload()
Get the decoded body of the job.
int|null maxTries()
Get the number of times to attempt a job.
int|null timeout()
Get the number of seconds the job can run.
int|null timeoutAt()
Get the timestamp indicating when the job should timeout.
string getName()
Get the name of the queued job class.
string resolveName()
Get the resolved name of the queued job class.
Resolves the name of "wrapped" jobs such as class-based handlers.
string getConnectionName()
Get the name of the connection the job belongs to.
string getQueue()
Get the name of the queue the job belongs to.
Container getContainer()
Get the service container instance.
void __construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)
Create a new job instance.
int attempts()
Get the number of times the job has been attempted.
SqsClient getSqs()
Get the underlying SQS client instance.
array getSqsJob()
Get the underlying raw SQS job.
© 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