W3cubDocs

/Laravel 4.2

SqsJob

class SqsJob extends 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.

int attempts()

Get the number of times the job has been attempted.

string getRawBody()

Get the raw body string for the job.

bool autoDelete()

Determine if job should be auto-deleted.

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

void fire()

Fire the job.

Return Value

void

void delete()

Delete the job from the queue.

Return Value

void

bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

void release(int $delay)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

int attempts()

Get the number of times the job has been attempted.

Return Value

int

string getRawBody()

Get the raw body string for the job.

Return Value

string

bool autoDelete()

Determine if job should be auto-deleted.

Return Value

bool

string getName()

Get the name of the queued job class.

Return Value

string

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

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

string getJobId()

Get the job identifier.

Return Value

string

Container getContainer()

Get the IoC container instance.

Return Value

Container

SqsClient getSqs()

Get the underlying SQS client instance.

Return Value

SqsClient

array getSqsJob()

Get the underlying raw SQS job.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Queue/Jobs/SqsJob.html