Package org.jobrunr.jobs.context

Class JobContext

java.lang.Object

org.jobrunr.jobs.context.JobContext

Direct Known Subclasses:

RunnerJobContext

public class JobContext
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobContext.Metadata

Field Summary

Fields

Modifier and Type	Field	Description
static JobContext	Null

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JobContext(Job job)	Keep constructor package protected to remove confusion on how to instantiate the JobContext.

Method Summary

Modifier and Type	Method	Description
java.time.Instant	getCreatedAt()
java.util.UUID	getJobId()
java.lang.String	getJobName()
StateName	getJobState()
java.util.Map<java.lang.String,java.lang.Object>	getMetadata()
java.lang.String	getSignature()
java.time.Instant	getUpdatedAt()
JobDashboardLogger	logger()
JobDashboardProgressBar	progressBar(int totalAmount)
JobDashboardProgressBar	progressBar(long totalAmount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Null

public static final JobContext Null

Constructor Detail

JobContext

protected JobContext(Job job)

Keep constructor package protected to remove confusion on how to instantiate the JobContext. Tip - To use the JobContext in your Job, pass JobContext.Null

Parameters:

job - the job for this JobContext

Method Detail

getJobId

public java.util.UUID getJobId()

getJobName

public java.lang.String getJobName()

getJobState

public StateName getJobState()

getCreatedAt

public java.time.Instant getCreatedAt()

getUpdatedAt

public java.time.Instant getUpdatedAt()

getSignature

public java.lang.String getSignature()

logger

public JobDashboardLogger logger()

progressBar

public JobDashboardProgressBar progressBar(int totalAmount)

progressBar

public JobDashboardProgressBar progressBar(long totalAmount)

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()