com.hof.mi.etl.runner.status

Interface ETLProcessStatus

All Known Implementing Classes:

ETLProcessStatusImpl

public interface ETLProcessStatus

Holds the status of an ETL Process.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ETLProcessStatus.ETLProcessStatusCode Status codes for the process

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Set the status of the process and unfinished steps to cancelled.
long	getEndTime() End time of the process as milliseconds from midnight, January 1, 1970 UTC.
java.lang.String	getProcessUuid() Get the UUID of the ETL Process whose status this object represents.
long	getStartTime() Start time of the process as milliseconds from midnight, January 1, 1970 UTC.
ETLProcessStatus.ETLProcessStatusCode	getStatusCode() Get the process's status code as defined in ETLProcessStatus.ETLProcessStatusCode
java.util.Map<java.lang.String,ETLStepStatus>	getStepStatusMap() Holds the status of each step in the Process.
boolean	hasErrors() Were there unhandled errors in execution?
boolean	isComplete() True if the process has finished executing.
void	registerStep(ETLStep step) Register an ETLStep object for recording status.
void	setStatusCode(ETLProcessStatus.ETLProcessStatusCode status) Set the process's status code to a value defined in ETLProcessStatus.ETLProcessStatusCode
java.lang.String	toJson() Serialise the status object into a JSON string

Method Detail

getProcessUuid

java.lang.String getProcessUuid()

Get the UUID of the ETL Process whose status this object represents.

getStepStatusMap

java.util.Map<java.lang.String,ETLStepStatus> getStepStatusMap()

Holds the status of each step in the Process. Key: StepUUID; Value: ETLStepStatus for that step.

registerStep

void registerStep(ETLStep step)

Register an ETLStep object for recording status.

isComplete

boolean isComplete()

True if the process has finished executing. It may not have finished successfully.

hasErrors

boolean hasErrors()

Were there unhandled errors in execution?

getStatusCode

ETLProcessStatus.ETLProcessStatusCode getStatusCode()

Get the process's status code as defined in ETLProcessStatus.ETLProcessStatusCode

setStatusCode

void setStatusCode(ETLProcessStatus.ETLProcessStatusCode status)

Set the process's status code to a value defined in ETLProcessStatus.ETLProcessStatusCode

cancel

void cancel()

Set the status of the process and unfinished steps to cancelled.

getStartTime

long getStartTime()

Start time of the process as milliseconds from midnight, January 1, 1970 UTC.

getEndTime

long getEndTime()

End time of the process as milliseconds from midnight, January 1, 1970 UTC.

toJson

java.lang.String toJson()

Serialise the status object into a JSON string