getJobSummaries

Back to index

Summary

Retrieves summary information about jobs.
filter
Arrayoptional
How to filter the results.
includeLastSuccess
Booleanoptional
Whether to include the last successful job, if not otherwise included.
maxFailedSteps
Integeroptional
The maximum number of failed steps to return.
maxJobs
Integeroptional
The maximum number of jobs to return.
maxRunningSteps
Integeroptional
The maximum number of running steps to return.

Usage

Perl

$cmdr->getJobSummaries( # optionals );

ectool

ectool getJobSummaries \ # optionals

Examples

Perl

$cmdr->getJobSummaries({maxFailedSteps => 6});

ectool

ectool getJobSummaries --maxFailedSteps 6