Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiJobStatusTracker

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiJobStatusTracker extends Tables.Table, PersistedObjectColumns
Table of the job status trackers of the partition. Each row tracks one background job, for example the calculation of a Price List, a Calculated Field Set or a Data Load, as listed on the Jobs & Tasks page.

Example, the jobs that ran for one object: 


 def q = api.queryApi()
 def jst = q.tables().jobStatusTrackers()

 return q.source(jst, [jst.jobName(), jst.trackerType(), jst.status(), jst.processingStart(), jst.processingEnd()],
         jst.targetObject().equal("2147485082.DMDL"))
         .stream { it.collect { it } }
Since:
15.3.14 - Southside, 16.1.1 - Black Cat
See Also:

  • Method Details

    • cancelRequested

      SelectableExpression cancelRequested()
      Returns whether a user requested the cancellation of the job. A running job checks this flag and stops.
      Returns:
      the cancelRequested column as a Boolean expression
      See Also:

    • trackerType

      SelectableExpression trackerType()
      Returns the type of the job, for example PRICELIST, PRICEGRID, CFS, PADATALOAD or CALCULATIONFLOW.
      Returns:
      the trackerType column as an Enum expression

    • jobName

      SelectableExpression jobName()
      Returns the name of the job.
      Returns:
      the jobName column as a String expression

    • processingStart

      SelectableExpression processingStart()
      Returns the date and time when the processing of the job started.
      Returns:
      the processingStart column as a DateTime expression
      See Also:

    • processingEnd

      SelectableExpression processingEnd()
      Returns the date and time when the processing of the job ended.
      Returns:
      the processingEnd column as a DateTime expression
      See Also:

    • status

      SelectableExpression status()
      Returns the status of the job. Possible values are:
      • WAITING_FOR_DISPATCH: created, waiting for an execution slot
      • QUEUED_FOR_EXECUTION: picked up by the scheduler and queued
      • PROCESSING: running
      • FAILED: failed
      • FINISHED: completed successfully
      • CANCELLED: cancelled by a user
      • INTERRUPTED: interrupted, for example by a node shutdown
      Returns:
      the status column as an Enum expression
      See Also:

    • targetObject

      SelectableExpression targetObject()
      Returns the typed ID of the object that the job runs for, for example 2147485082.DMDL for a Data Load.
      Returns:
      the targetObject column as a String expression

    • progress

      SelectableExpression progress()
      Returns the progress of the job as text, for example 100%. Jobs that run as a single operation do not report progress.
      Returns:
      the progress column as a String expression

    • processingNode

      SelectableExpression processingNode()
      Returns the name of the node that processes the job.
      Returns:
      the processingNode column as a String expression
      See Also:

    • threadUUID

      SelectableExpression threadUUID()
      Returns the universally unique identifier (UUID) of the thread that processes the job.
      Returns:
      the threadUUID column as a String expression
      See Also:

    • lightweight

      SelectableExpression lightweight()
      Returns whether the job is lightweight. Lightweight jobs always run on the backend nodes instead of in a dedicated pod.
      Returns:
      the lightweight column as a Boolean expression

    • concurrencyKey

      SelectableExpression concurrencyKey()
      Returns the concurrency key of the job, for example 2148068499.JST. Jobs with the same concurrency key run one at a time; jobs without a key have no such constraint.
      Returns:
      the concurrencyKey column as a String expression

    • hasWarning

      SelectableExpression hasWarning()
      Returns whether the job ended with a warning, for example a warning or an alert in its calculation results.
      Returns:
      the hasWarning column as a Boolean expression
      See Also: