1. class
  2. Illuminate
  3. Queue
  4. Jobs
  5. SqsJob

SqsJob

class SqsJob extends Job implements Job (View source)

Methods

void
fire()

Fire the job.

void
delete()

Delete the job from the queue.

bool
isDeleted()

Determine if the job has been deleted.

from Job
void
release( int $delay)

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
int
attempts()

Get the number of times the job has been attempted.

string
getRawBody()

Get the raw body string for the job.

void
failed()

Call the failed method on the job instance.

from Job
string
getName()

Get the name of the queued job class.

from Job
string
getQueue()

Get the name of the queue the job belongs to.

from Job
void
__construct( Container $container, SqsClient $sqs, string $queue, array $job)

Create a new job instance.

string
getJobId()

Get the job identifier.

Container
getContainer()

Get the IoC container instance.

SqsClient
getSqs()

Get the underlying SQS client instance.

array
getSqsJob()

Get the underlying raw SQS job.

Details

at line line 50
void fire()

Fire the job.

Return Value

void

at line line 70
void delete()

Delete the job from the queue.

Return Value

void

in Job at line line 67
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

at line line 87
void release( int $delay)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

in Job at line line 88
bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

in Job at line line 98
bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

at line line 103
int attempts()

Get the number of times the job has been attempted.

Return Value

int

at line line 60
string getRawBody()

Get the raw body string for the job.

Return Value

string

in Job at line line 203
void failed()

Call the failed method on the job instance.

Return Value

void

in Job at line line 256
string getName()

Get the name of the queued job class.

Return Value

string

in Job at line line 266
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

at line line 34
void __construct( Container $container, SqsClient $sqs, string $queue, array $job)

Create a new job instance.

Parameters

Container $container
SqsClient $sqs
string $queue
array $job

Return Value

void

at line line 113
string getJobId()

Get the job identifier.

Return Value

string

at line line 123
Container getContainer()

Get the IoC container instance.

Return Value

Container

at line line 133
SqsClient getSqs()

Get the underlying SQS client instance.

Return Value

SqsClient

at line line 143
array getSqsJob()

Get the underlying raw SQS job.

Return Value

array