com.mulesoft.mule.runtime.module.batch.api

Interface BatchJobInstance

All Superinterfaces:

Serializable

@NoImplement
public interface BatchJobInstance
extends Serializable

This class represents a single execution of a BatchJob. It allows tracking that execution's statistics, result, id, status, etc. One job instance is related to one and only one BatchJob

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
Date	getCreationTime() The instant at which this instance was created.
String	getId() Returns the id of this execution.
String	getOwnerJobName() The name of the BatchJob that spawned this instance
long	getRecordCount() Returns the total number of records that this instance is bound to process
BatchJobResult	getResult() Reflects the final result of the job execution.
BatchJobInstanceStatus	getStatus() Returns this instance's status

Method Detail

getId

String getId()

Returns the id of this execution. This id has to be unique for all instances of the same job

Returns:

a non empty String

getResult

BatchJobResult getResult()

Reflects the final result of the job execution. This object is updated on the fly so that it also reflects partial progress

Returns:

a BatchJobResult

getStatus

BatchJobInstanceStatus getStatus()

Returns this instance's status

Returns:

a BatchJobInstanceStatus

getRecordCount

long getRecordCount()

Returns the total number of records that this instance is bound to process

Returns:

a positive integer greater than zero

getOwnerJobName

String getOwnerJobName()

The name of the BatchJob that spawned this instance

Returns:

a non empty String

getCreationTime

Date getCreationTime()

The instant at which this instance was created.

Returns:

a not null Date