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

Interface BatchJobResult

All Superinterfaces:

Serializable

@NoImplement
public interface BatchJobResult
extends Serializable

This pojo contains information about the results of a job instance's processing. It can also be used to get information about execution progress

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
String	getBatchJobInstanceId() The id of the owning BatchJobInstance
long	getElapsedTimeInMillis() How many milliseconds the BatchJobInstance has been in executing state.
long	getFailedRecords() How many records were processed and failed in at least one step
Exception	getInputPhaseException() If the input phase failed, this method returns an exception info object
long	getLoadedRecords() How many records were loaded so far.
Exception	getLoadingPhaseException() If the loading phase failed, this method returns an exception info object
Exception	getOnCompletePhaseException() If the on complete phase failed, this method returns an exception info object
long	getProcessedRecords() How many records already went through all steps so far.
BatchStepResult	getResultForStep(String stepId) Retrieves information about the execution of a particular step
long	getSuccessfulRecords() How many records were processed through all the steps without failing any of them
long	getTotalRecords() Total number of records in the batch
boolean	isFailedOnCompletePhase() Wether an exeption was found on the on complete phase
boolean	isFailedOnInputPhase() Wether an exeption was found on the on input phase
boolean	isFailedOnLoadingPhase() Wether an exeption was found on the on loading phase

Method Detail

getResultForStep

BatchStepResult getResultForStep(String stepId)

Retrieves information about the execution of a particular step

Parameters:

stepId - the id of a step in the owning BatchJob

Returns:

a BatchStepResult

getElapsedTimeInMillis

long getElapsedTimeInMillis()

How many milliseconds the BatchJobInstance has been in executing state. If the job is stopped and then resumed, this method is smart enough to filter the interval

getSuccessfulRecords

long getSuccessfulRecords()

How many records were processed through all the steps without failing any of them

getFailedRecords

long getFailedRecords()

How many records were processed and failed in at least one step

getTotalRecords

long getTotalRecords()

Total number of records in the batch

getLoadedRecords

long getLoadedRecords()

How many records were loaded so far. When loading phase has finished, this method's return value should match the one of getTotalRecords()

getProcessedRecords

long getProcessedRecords()

How many records already went through all steps so far. When execution phase has finished, this method's return value should match the one of getTotalRecords()

getBatchJobInstanceId

String getBatchJobInstanceId()

The id of the owning BatchJobInstance

Returns:

a non empty String

isFailedOnInputPhase

boolean isFailedOnInputPhase()

Wether an exeption was found on the on input phase

getInputPhaseException

Exception getInputPhaseException()

If the input phase failed, this method returns an exception info object

Returns:

a Exception

isFailedOnLoadingPhase

boolean isFailedOnLoadingPhase()

Wether an exeption was found on the on loading phase

getLoadingPhaseException

Exception getLoadingPhaseException()

If the loading phase failed, this method returns an exception info object

Returns:

a Exception

isFailedOnCompletePhase

boolean isFailedOnCompletePhase()

Wether an exeption was found on the on complete phase

getOnCompletePhaseException

Exception getOnCompletePhaseException()

If the on complete phase failed, this method returns an exception info object

Returns:

a Exception