Jobqueue methods

Job Queue API actions provide external actors with ways to query and manipulate jobs and their recurring definitions. The following is a list of methods available for the Job Queue feature:

<ul> <li>The jobqueueListJobs Method</li> <li>The jobqueueJobInfo Method</li> <li>The jobqueueDeleteJob Method</li> <li>The jobqueueRequeueJob Method</li> <li>The jobqueueListRules Method</li> <li>The jobqueueRuleInfo Method</li> <li>The jobqueueSaveRule Method</li> <li>The jobqueueDisableRules Method </li> <li>The jobqueueResumeRules Method </li> <li>The jobqueueDeleteRules Method</li> <li>The jobqueueRunNowRule Method</li> </ul>

The jobqueueJobsList Method

Job Queue API actions provide external actors with ways to query and manipulate jobs and their recurring definitions.

Method jobqueueJobsList definition

<?php
public function jobqueueJobsList($limit = null, $offset = null, $orderBy = null, $direction = null, $filter = null) { }
Parameter
Parameter Data Type Default value Required Description
$limit int   no Row limit to retrieve, defaults to value defined in zend-user-user.ini
$offset int 0 no The page offset to be displayed, defaults to 0
$orderBy string Date no Column to sort the result by (), defaults to Date
$direction string DESC no Sorting direction: ASC or DESC.
$filters array array() no Associative array, accteps any of the following keys: app_id, name, script, priority, status, rule_id, scheduled_before, scheduled_after, executed_before, executed_after, freeText The priority key, accepts the following values: low, normal, high, urgent. The status key, accepts the following values: Active, Waiting, Running, Completed, Failed, Timeout, Removed, Scheduled, Suspende

jobqueueJobsList information

Return value \ZendService\ZendServerAPI\DataTypes\Jobs (Jobs api doc)
Online reference jobqueueJobsList online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueJobsList();

The jobqueueJobInfo Method

Retrieve and display details of a job.

Method jobqueueJobInfo definition

<?php
public function jobqueueJobInfo($id) { }
Parameter
Parameter Data Type Default value Required Description
$id int   yes job id

jobqueueJobInfo information

Return value \ZendService\ZendServerAPI\DataTypes\JobInfo (JobInfo api doc)
Online reference jobqueueJobInfo online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobInfo = $jobqueue->jobqueueJobInfo(1);

The jobqueueDeleteJobs Method

Delete job queue.

Method jobqueueDeleteJobs definition

<?php
public function jobqueueDeleteJobs(array $ids) { }
Parameter
Parameter Data Type Default value Required Description
$ids array   yes job ids

jobqueueDeleteJobs information

Return value \ZendService\ZendServerAPI\DataTypes\Jobs (Jobs api doc)
Online reference jobqueueDeleteJobs online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueDeleteJobs(array(1));

The jobqueueRequeueJobs Method

Requeue a job.

Method jobqueueRequeueJobs definition

<?php
public function jobqueueRequeueJobs(array $ids) { }
Parameter
Parameter Data Type Default value Required Description
$ids array   yes job ids

jobqueueRequeueJobs information

Return value \ZendService\ZendServerAPI\DataTypes\Jobs (Jobs api doc)
Online reference jobqueueRequeueJobs online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueRequeueJobs(array(1));

The jobqueueListRules Method

Retrieve and display a list of jobs rules.

Method jobqueueListRules definition

<?php
public function jobqueueListRules($limit = null, $offset = null, $orderBy = null, $direction = null) { }
Parameter
Parameter Data Type Default value Required Description
$limit int   no Row limit to retrieve, defaults to value defined in zend-user-user.ini
$offset int 0 no The page offset to be displayed, defaults to 0
$orderBy string Date no Column to sort the result by (), defaults to Date
$direction string DESC no Sorting direction: ASC or DESC.

jobqueueListRules information

Return value \ZendService\ZendServerAPI\DataTypes\Jobs (Rules api doc)
Online reference jobqueueListRules online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueListRules();

The jobqueueRuleInfo Method

Retrieve and display a job rule information.

Method jobqueueRuleInfo definition

<?php
public function jobqueueRuleInfo($id) { }
Parameter
Parameter Data Type Default value Required Description
$id int   yes job id

jobqueueRuleInfo information

Return value \ZendService\ZendServerAPI\DataTypes\RuleInfo (RuleInfo api doc)
Online reference jobqueueRuleInfo online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueRuleInfo(1);

The jobqueueSaveRule Method

Create a job queue rule.

Method jobqueueSaveRule definition

<?php
public function jobqueueSaveRule($url, $options, $vars = array()) { }
Parameter
Parameter Data Type Default value Required Description
$url string   yes A URL for the job.
$options string   yes Rule options. (schedule pattern)
$vars array   no Variables for the rule.

jobqueueSaveRule information

Return value \ZendService\ZendServerAPI\DataTypes\RuleInfo (RuleInfo api doc)
Online reference jobqueueSaveRule online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueSaveRule("http://www.example.com/foo", "1 */10");

The jobqueueDisableRules Method

Suspend a job queue rule.

Method jobqueueDisableRules definition

<?php
public function jobqueueDisableRules(array $ruleIds) { }
Parameter
Parameter Data Type Default value Required Description
$ruleIds array   yes Array of rule ids

jobqueueDisableRules information

Return value \ZendService\ZendServerAPI\DataTypes\Rules (Rules api doc)
Online reference jobqueueDisableRules online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueDisableRules(array(1));

The jobqueueResumeRules Method

Resume a suspended job queue rule.

Method jobqueueResumeRules definition

<?php
public function jobqueueResumeRules(array $ruleIds) { }
Parameter
Parameter Data Type Default value Required Description
$ruleIds array   yes Array of rule ids

jobqueueResumeRules information

Return value \ZendService\ZendServerAPI\DataTypes\Rules (Rules api doc)
Online reference jobqueueResumeRules online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueResumeRules(array(1));

The jobqueueDeleteRules Method

Delete a job queue rule.

Method jobqueueDeleteRules definition

<?php
public function jobqueueDeleteRules(array $ruleIds) { }
Parameter
Parameter Data Type Default value Required Description
$ruleIds array   yes Array of rule ids

jobqueueDeleteRules information

Return value \ZendService\ZendServerAPI\DataTypes\Rules (Rules api doc)
Online reference jobqueueDeleteRules online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueDeleteRules(array(1));

The jobqueueRunNowRule Method

Run a scheduled job that was scheduled for a later time.

Method jobqueueRunNowRule definition

<?php
public function jobqueueRunNowRule($ruleId) { }
Parameter
Parameter Data Type Default value Required Description
$ruleId int   yes Rule id

jobqueueRunNowRule information

Return value \ZendService\ZendServerAPI\DataTypes\RuleInfo (RuleInfo api doc)
Online reference jobqueueRunNowRule online reference
Available in Version
  • 1.3

Example

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueRunNowRule(1);