public final class OdiSessionStepLog
extends AbstractRepositoryEntity
Execution log of an OdiSession's step. A step is the unit of execution found between a task and a session.
It corresponds to a step in a package or in a scenario. When executing an interface or a single variable, for example,
a session has only one session step. It is part of the OdiSession - OdiSessionVariable -
OdiSessionStepLog aggregate. However, it is also root of the OdiSessionStepLog -
OdiSessionTaskLog aggregate.
An OdiSessionStepLog life cycle begins when an ODI session step is runned by ODI Execution Engine.
Its life cycle ends when enclosing @link OdiSession} is removed from runtime repository.
| Constructor and Description |
|---|
OdiSessionStepLog(OdiSession session,
OdiSessionBlueprintStep step) |
| Modifier and Type | Method and Description |
|---|---|
void |
addSessionTaskLog(OdiSessionTaskLog pSessTaskLog)
Add session task logs of this session step log
|
java.lang.String |
getContextCode()
Deprecated.
replaced by {@link #getStep()#getContextCode()
|
java.lang.Integer |
getDeleteCount()
Deprecated.
consider using
getDeleteCountLong() instead. |
java.lang.Long |
getDeleteCountLong()
Returns the number of processed deletes, or
null if not applicable. |
java.lang.Integer |
getDuration()
Returns the duration (in second) of this step's execution, or
null if not yet defined. |
java.util.Date |
getEndTime()
Returns the end time for this step, or
null if not yet finished. |
java.lang.Integer |
getErrorCount()
Deprecated.
consider using
getErrorCountLong() instead. |
java.lang.Long |
getErrorCountLong()
Obtains the number of errors for this step.
|
java.lang.String |
getErrorMessage()
Returns the error message for this step if any.
|
int |
getExecutionCount()
Returns the internal count of execution of this same
OdiSessionStepLog
within the session execution. |
int |
getExecutionOrder()
Reruns the order of execution of this step within the
OdiSession. |
java.lang.String |
getExternalId()
Obtains an Oozie jobId for this
OdiSessionStepLog. |
java.lang.String |
getExternalUrl()
Obtains the Url of the Oozie JobTracker for this
OdiSessionStepLog
for Oozie sessions and returns null for ODI native sessions. |
int |
getFailureRetryDelay()
Deprecated.
replaced by
getStep#getFailureRetryDelay() |
int |
getFailureRetryNumber()
Deprecated.
replaced by
getStep#getFailureRetryNumber() |
OdiTrackedSequenceValue |
getFirstTrackedSequenceValue(OdiSessionBlueprintSequence pSessionBlueprintSequence)
Convenient method to obtain first tracked occurrence of a given
OdiSessionBlueprintSequence
in OdiSessionTaskLogs belonging this step execution. |
OdiTrackedSequenceValue |
getFirstTrackedSequenceValue(OdiSessionSequence pSequence)
Deprecated.
|
java.lang.Integer |
getInsertCount()
Deprecated.
consider using
getInsertCountLong() instead. |
java.lang.Long |
getInsertCountLong()
Returns the number of processed inserts, or
null if not applicable. |
java.io.Serializable |
getInternalId() |
java.lang.String |
getKoExitCode()
Deprecated.
replaced by
getStep#getKoExitCode() |
OdiTrackedSequenceValue |
getLastTrackedSequenceValue(OdiSessionBlueprintSequence pSessionBlueprintSequence)
Convenient method to obtain last tracked occurrence of a given
OdiSessionBlueprintSequence
in OdiSessionTaskLogs belonging this step execution. |
OdiTrackedSequenceValue |
getLastTrackedSequenceValue(OdiSessionSequence pSequence)
Deprecated.
|
java.util.Date |
getLastUpdated()
Obtains the date that this
OdiSessionStepLog was last updated. |
java.lang.Integer |
getMaxErrorCount()
Deprecated.
replaced by
#getStep()#getMaxErrorCount() |
java.lang.String |
getName()
Deprecated.
replaced by
#getStep()#getName() |
OdiSessionStepLog |
getNextStepAfterFailure()
Deprecated.
with no direct replacement,
consider using
OdiSessionBlueprintStep.getNextStepAfterFailure() and
OdiSessionBlueprintStep.getSessionStepLog(OdiSession, int) instead |
OdiSessionStepLog |
getNextStepAfterSuccess()
Deprecated.
with no direct replacement,
consider using
OdiSessionBlueprintStep.getNextStepAfterSuccess() and
OdiSessionBlueprintStep.getSessionStepLog(OdiSession, int) instead |
java.lang.String |
getOkExitCode()
Deprecated.
replaced by
getStep#getOkExitCode() |
java.lang.Integer |
getRecordCount()
Deprecated.
consider using
getRecordCountLong() instead. |
java.lang.Long |
getRecordCountLong()
Returns overall number of records processed by this step, or
null if not applicable. |
java.lang.String |
getReturnCode()
Obtains the return code for this step.
|
IRepositoryEntity |
getSecurityContainer() |
OdiSession |
getSession()
Returns the enclosing session execution.
|
OdiSessionBlueprintStep |
getSessionBlueprintStep()
Returns the related step object from session blueprint (
OdiSessionBlueprintStep). |
OdiSessionCustomStep |
getSessionCustomStep()
Returns the related
OdiSessionCustomStep, if some blueprint values were
overridden between restarts, or if related step is of OnConnect/OnDisconnect type;
null - otherwise. |
java.lang.Number |
getSessionId()
Deprecated.
As of 11.1.1.5 this method is replaced by
getSession() |
java.util.List |
getSessionTaskLogs()
Obtains ordered unmodifiable list of task logs (
OdiSessionTaskLog) that belong to this OdiSessionStepLog. |
java.util.Date |
getStartTime()
Returns the start time for this step, or
null if not yet started. |
Status |
getStatus()
Obtains the current status of this step execution.
|
AbstractRuntimeStep |
getStep()
Returns the step which this
OdiSessionStepLog is related to. |
int |
getStepNumber()
Returns the internally calculated sequence number of this
OdiSessionStepLog within the initial package. |
StepType |
getStepType()
Deprecated.
replaced by
#getStep()#getType() |
java.lang.String |
getSummaryMessage()
Obtains the a textual summary of the execution at the step/action level
for this
OdiSessionStepLog for Oozie sessions and returns null
for ODI native sessions. |
java.lang.String |
getTargetLogicalSchemaName()
Deprecated.
replaced by
#getStep()#getTargetLogicalSchemaName() |
java.lang.String |
getTargetModelCode()
Deprecated.
replaced by
#getStep()#getTargetModelCode() |
java.lang.String |
getTargetResourceName()
Deprecated.
replaced by
getStep#getTargetResourceName() |
java.lang.String |
getTargetTableName()
Deprecated.
replaced by
getStep#getTargetTableName() |
java.util.Collection |
getTrackedVariableValues()
Obtains the tracked values of session's variables for this step execution.
|
java.lang.Integer |
getUpdateCount()
Deprecated.
consider using
getUpdateCountLong() instead. |
java.lang.Long |
getUpdateCountLong()
Returns overall number of updates processed by this step, or
null if not applicable. |
java.lang.Number |
getVariableIncrement()
Deprecated.
replaced by
getStep#getVariableIncrement() |
java.lang.String |
getVariableName()
Deprecated.
replaced by
getStep#getVariableName() |
VariableOperator |
getVariableOperator()
Deprecated.
replaced by
getStep#getVariableOperator() |
java.lang.String |
getVariableValue()
Deprecated.
replaced by
getStep#getVariableValue() |
boolean |
isCleanedUp()
Returns
true if cleanup tasks were performed and false otherwise. |
boolean |
isContextForced()
Deprecated.
replaced by
#getStep()#isContextForced() |
boolean |
isKoExit()
Deprecated.
replaced by
getStep#isKoExit() |
boolean |
isMaxErrorCountAsPercentage()
Deprecated.
replaced by
#getStep()#isMaxErrorCountAsPercentage() |
boolean |
isOkExit()
Deprecated.
replaced by
getStep#isOkExit() |
boolean |
isTrackingEnabled()
Returns whether variable and sequence value tracking is enabled for this
OdiSessionStepLog.
|
void |
setCleanedUp(boolean pCleanedUp)
Sets "cleanedUp" flag telling if cleanup tasks were performed.
|
void |
setMaxErrorCount(java.lang.Integer pMaxErrorCount)
Deprecated.
consider creation/editing of
OdiSessionCustomStep instead. |
void |
setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
Deprecated.
consider creation/editing of
OdiSessionCustomStep instead. |
void |
setStatus(Status pStatus)
Set the current status of this step execution.
|
public OdiSessionStepLog(OdiSession session, OdiSessionBlueprintStep step)
public java.util.List getSessionTaskLogs()
OdiSessionTaskLog) that belong to this OdiSessionStepLog.public java.lang.String getContextCode()
OdiSessionStepLog. Maybe the execution context, or a forced context for this step.public java.lang.Long getDeleteCountLong()
null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getDeleteCount()
getDeleteCountLong() instead.null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getDuration()
null if not yet defined.public java.util.Date getEndTime()
null if not yet finished.public java.lang.Long getErrorCountLong()
public java.lang.Integer getErrorCount()
getErrorCountLong() instead.public java.lang.String getErrorMessage()
null if not failed.public int getExecutionCount()
OdiSessionStepLog
within the session execution.public java.lang.String getExternalId()
OdiSessionStepLog.public java.lang.String getExternalUrl()
OdiSessionStepLog
for Oozie sessions and returns null for ODI native sessions.public java.lang.String getSummaryMessage()
OdiSessionStepLog for Oozie sessions and returns null
for ODI native sessions.public java.util.Date getLastUpdated()
OdiSessionStepLog was last updated.public boolean isContextForced()
#getStep()#isContextForced()true if context was forced, false otherwisepublic java.lang.Long getInsertCountLong()
null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getInsertCount()
getInsertCountLong() instead.null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.io.Serializable getInternalId()
public java.lang.String getName()
#getStep()#getName()OdiSessionStepLog. This name matches the name of the step as defined in the
package that has generated the scenario otherwise it matches the name of the executed object such as OdiInterface,
OdiVariable, OdiProcedure etc.public java.lang.Long getRecordCountLong()
null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getRecordCount()
getRecordCountLong() instead.null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.String getReturnCode()
public IRepositoryEntity getSecurityContainer()
public java.util.Date getStartTime()
null if not yet started.public Status getStatus()
setStatus(Status)public void setStatus(Status pStatus)
pStatus - the statusgetStatus()public int getStepNumber()
OdiSessionStepLog within the initial package.OdiSessionStepLog within the initial packagepublic StepType getStepType()
#getStep()#getType()OdiSessionStepLog.public java.lang.String getTargetLogicalSchemaName()
#getStep()#getTargetLogicalSchemaName()public java.lang.String getTargetModelCode()
#getStep()#getTargetModelCode()public java.lang.String getTargetResourceName()
getStep#getTargetResourceName()public java.lang.String getTargetTableName()
getStep#getTargetTableName()public java.lang.Long getUpdateCountLong()
null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getUpdateCount()
getUpdateCountLong() instead.null if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public boolean isMaxErrorCountAsPercentage()
#getStep()#isMaxErrorCountAsPercentage()true if percentage, false otherwise.getMaxErrorCount()public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
OdiSessionCustomStep instead.pMaxErrorCountAsPercentage - true to indicate a percentage, false otherwiseisMaxErrorCountAsPercentage()public java.lang.Integer getMaxErrorCount()
#getStep()#getMaxErrorCount()setMaxErrorCount(Integer),
isMaxErrorCountAsPercentage()public void setMaxErrorCount(java.lang.Integer pMaxErrorCount)
OdiSessionCustomStep instead.pMaxErrorCount - the maximum of errorsgetMaxErrorCount(),
setMaxErrorCountAsPercentage(boolean)public java.lang.Number getSessionId()
getSession()OdiSession this OdiSessionStepLog is related to.public OdiSessionStepLog getNextStepAfterFailure()
OdiSessionBlueprintStep.getNextStepAfterFailure() and
OdiSessionBlueprintStep.getSessionStepLog(OdiSession, int) insteadOdiSessionStepLog, if it failed.
If no next OdiSessionStepLog was defined (null is defined), the execution will
stop after failure.
null is nonepublic OdiSessionStepLog getNextStepAfterSuccess()
OdiSessionBlueprintStep.getNextStepAfterSuccess() and
OdiSessionBlueprintStep.getSessionStepLog(OdiSession, int) insteadOdiSessionStepLog, if it succeeds.
If no next OdiSessionStepLog was defined (null is defined), the execution will
stop after success.
public java.lang.String getKoExitCode()
getStep#getKoExitCode()public java.lang.String getOkExitCode()
getStep#getOkExitCode()public boolean isOkExit()
getStep#isOkExit()true if exit required on success, false - otherwise.true if exit required on success, false - otherwisepublic boolean isKoExit()
getStep#isKoExit()true if exit required on failure, false - otherwise.true if exit required on failure, false - otherwisepublic int getFailureRetryNumber()
getStep#getFailureRetryNumber()public int getFailureRetryDelay()
getStep#getFailureRetryDelay()public java.lang.String getVariableName()
getStep#getVariableName()public java.lang.String getVariableValue()
getStep#getVariableValue()These values are evaluated before the execution of the step
.public java.lang.Number getVariableIncrement()
getStep#getVariableIncrement()public VariableOperator getVariableOperator()
getStep#getVariableOperator()VariableOperator}public int getExecutionOrder()
OdiSession.public java.util.Collection getTrackedVariableValues()
OdiSession.public boolean isTrackingEnabled()
true if tracking is enabled, false otherwisepublic OdiTrackedSequenceValue getFirstTrackedSequenceValue(OdiSessionSequence pSequence)
getFirstTrackedSequenceValue(OdiSessionBlueprintSequence)OdiSessionSequence
in OdiSessionTaskLogs belonging this step execution. If there is no tracked value
of the given sequence, or if tracking is disabled it will return null.pSequence - a sequencenullpublic OdiTrackedSequenceValue getFirstTrackedSequenceValue(OdiSessionBlueprintSequence pSessionBlueprintSequence)
OdiSessionBlueprintSequence
in OdiSessionTaskLogs belonging this step execution. If there is no tracked value
of the given sequence, or if tracking is disabled it will return null.pSessionBlueprintSequence - a sequencenullpublic OdiTrackedSequenceValue getLastTrackedSequenceValue(OdiSessionSequence pSequence)
OdiSessionSequence
in OdiSessionTaskLogs belonging this step execution. If there is no tracked value
of the given sequence, or if tracking is disabled it will return null.pSequence - a sequencenullpublic OdiTrackedSequenceValue getLastTrackedSequenceValue(OdiSessionBlueprintSequence pSessionBlueprintSequence)
OdiSessionBlueprintSequence
in OdiSessionTaskLogs belonging this step execution. If there is no tracked value
of the given sequence, or if tracking is disabled it will return null.pSessionBlueprintSequence - a sequencenullpublic OdiSession getSession()
public OdiSessionBlueprintStep getSessionBlueprintStep()
OdiSessionBlueprintStep).public OdiSessionCustomStep getSessionCustomStep()
OdiSessionCustomStep, if some blueprint values were
overridden between restarts, or if related step is of OnConnect/OnDisconnect type;
null - otherwise.OdiSessionCustomSteppublic AbstractRuntimeStep getStep()
OdiSessionStepLog is related to.
This could be an instance of OdiSessionBlueprintStep or OdiSessionCustomStep
in case of OnConnect/OnDisconnect or overridden step.public boolean isCleanedUp()
true if cleanup tasks were performed and false otherwise.public void setCleanedUp(boolean pCleanedUp)
pCleanedUp - if cleanup tasks were performed.public void addSessionTaskLog(OdiSessionTaskLog pSessTaskLog)
pSessTaskLog - - the new session task log to be added.