QueueableJob
class QueueableJob
Delayed Job
Properties
| protected string | $queue | ||
| protected int | $maxRetries | ||
| protected int | $retryDelay | ||
| protected DateTimeInterface|null | $scheduledDateTime | Should the scheduling be delayed |
|
| protected string|null | $uniquenessKey | ||
| protected string|null | $referenceId | ||
| protected string|null | $idToken | Token ID - available during Execution |
|
| protected int | $reScheduleDelay | If not 0 the job will be re-scheduled after this delay |
|
| protected string | $reScheduledJobId |
Methods
ID Token will become available AFTER schedule
No description
Returns the URI to the job status page
Helper to get the JobQueue module
When requested on existing job, this will show max retries left
No description
Returns the number of seconds if the tasks should be rescheduled or false if not
Define a reference ID which can later be used to lookup this job
No description
No description
Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled
Reschedule the currently running task (can only be used in execute() function) The function will not reduce retry_count and could lead to a looped execution
No description
No description
How may times should a job be retried when it failed.
No description
No description
Define a reference ID which can later be used to lookup this job
No description
No description
Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled
Details
at line 65
__construct(Job $job)
No description
at line 160
string|null
getIdToken()
ID Token will become available AFTER schedule
at line 176
Job
getJob()
No description
at line 310
string
getJobApiToken(string $worker = 'video')
No description
at line 287
string|null
getJobCallbackURI()
Returns the URI to the job status page
at line 257
static JobQueueController
getJobQueueModule()
Helper to get the JobQueue module
at line 75
int
getMaxRetries()
When requested on existing job, this will show max retries left
at line 183
string
getQueue()
No description
at line 134
int
getReScheduleDelay()
Returns the number of seconds if the tasks should be rescheduled or false if not
at line 112
string|null
getReferenceKey()
Define a reference ID which can later be used to lookup this job
at line 79
int
getRetryDelay()
No description
at line 269
DateTimeInterface|null
getScheduledDateTime()
No description
at line 89
string|null
getUniqueId()
Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled
at line 218
QueueableJob
reSchedule(int $delayInSeconds = 1)
Reschedule the currently running task (can only be used in execute() function) The function will not reduce retry_count and could lead to a looped execution
at line 235
QueueableJob
schedule()
No description
at line 151
setIdToken(string $idToken)
No description
at line 205
QueueableJob
setMaxRetries(int $maxRetries = 0)
How may times should a job be retried when it failed.
You can use this setting if you expect your job to need multiple retries
at line 192
QueueableJob
setQueue(string $queue)
No description
at line 167
setReScheduledJobId(string $jobId)
No description
at line 123
QueueableJob
setReferenceKey(string|null $referenceId)
Define a reference ID which can later be used to lookup this job
at line 143
QueueableJob
setRetryDelay(int $retryDelay)
No description
at line 278
QueueableJob
setScheduledDateTime(DateTimeInterface|null $scheduledDateTime)
No description
at line 101
QueueableJob
setUniqueId(string|null $uniqueKey)
Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled