WJb Docs - Reference

Browse APIs, configuration options, interfaces, and implementation details.

⚡ Actions
🔀 Workflow
📦 Jobs
⚙️ Runtime
💾 Persistence
🗄 Storage
🧩 Workflow Metadata
🛠 Extensions & Helpers

JobInfo

Represents a job tracked by the WJb runtime.

JobInfo is the primary model used to inspect, query, monitor, and manage jobs.

Purpose

A JobInfo instance describes the current state of a job.

Enqueue
   ↓
 JobInfo
   ↓
Execution
   ↓
Completion

Stores, workers, dashboards, and queries use JobInfo to understand what has happened to a job.

Responsibilities

A job information record typically contains:

  • Job identifier
  • Action information
  • Current status
  • Scheduling information
  • Progress information
  • Creation timestamps
  • Runtime metadata

Lifecycle

A job normally progresses through multiple states.

Pending
   ↓
Running
   ↓
Succeeded

or

Pending
   ↓
Running
   ↓
Failed

JobInfo reflects the current state of that lifecycle.

Monitoring

JobInfo is commonly used by:

  • Job dashboards
  • Administrative tools
  • Monitoring systems
  • Runtime diagnostics
  • Query APIs

Querying Jobs

Job queries typically return one or more JobInfo instances.

JobQuery
    ↓
 JobInfo

This allows applications to inspect execution history and runtime state.

Relationship to JobStatus

JobStatus describes the current state.

JobInfo contains the complete job record.

JobInfo
    ↓
JobStatus

Relationship to JobProgress

Progress information is associated with a job.

JobInfo
    ↓
JobProgress

Best Practices

Treat JobInfo as Read-Oriented Data

Application code will often read job information for monitoring and diagnostics.

Query Instead of Tracking State Manually

Prefer retrieving job information through the WJb APIs instead of maintaining separate tracking records.

Use Status for Workflow State

Use JobStatus when determining execution state.

Related Types

  • JobStatus
  • JobProgress
  • JobQuery
  • JobEnvelope
  • JobOptions

See Also

  • JobStatus
  • JobProgress
  • JobQuery
  • JobEnvelope
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.