Class JobInstance

java.lang.Object
org.springframework.batch.core.Entity
org.springframework.batch.core.job.JobInstance
All Implemented Interfaces:
Serializable
public class JobInstance extends Entity
Batch domain object representing a uniquely identifiable job run. JobInstance can be restarted multiple times in case of execution failure, and its lifecycle ends with first successful execution.

Trying to execute an existing JobInstance that has already completed successfully results in an error. An error is also raised for an attempt to restart a failed JobInstance if the Job is not restartable.

Author:
Lucas Ward, Dave Syer, Robert Kasanicky, Michael Minella, Mahmoud Ben Hassine
See Also:

  • Constructor Details

    • JobInstance

      public JobInstance(long id, String jobName)
      Constructor for JobInstance.
      Parameters:
      id - The instance ID.
      jobName - The name associated with the JobInstance.

  • Method Details

    • getJobName

      public String getJobName()
      Returns:
      the job name. (Equivalent to getJob().getName()).

    • getJobExecutions

      public List<JobExecution> getJobExecutions()
      Returns an immutable copy of the list of JobExecutions associated with this JobInstance.
      Returns:
      the job executions

    • toString

      public String toString()
      Adds the job name to the string representation of the super class (Entity).
      Overrides:
      toString in class Entity

    • getInstanceId

      public long getInstanceId()
      Returns:
      The current instance ID.

    • addJobExecution

      public void addJobExecution(JobExecution jobExecution)