Interface IBaseCommandData
-
- All Known Implementing Classes:
BaseCommandContext
public interface IBaseCommandData
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CommandState
getCommandState()
Get the command state for the associated completed command.EnvVars
getEnvVars()
To get the environment variable bindings, this method should be called in prefer togetJobContext().envVars()
.JobContext
getJobContext()
void
logError(Exception ex)
void
logError(String message)
void
logError(String prefix, Exception ex)
void
logStatus(String status)
void
setCommandState(CommandState state)
Set the command state for the associated running command.
-
-
-
Method Detail
-
logError
void logError(String message)
-
logStatus
void logStatus(String status)
-
logError
void logError(Exception ex)
-
setCommandState
void setCommandState(CommandState state)
Set the command state for the associated running command.- Parameters:
state
- the result command state.
-
getCommandState
CommandState getCommandState()
Get the command state for the associated completed command.- Returns:
- the result command state.
-
getJobContext
JobContext getJobContext()
-
getEnvVars
EnvVars getEnvVars()
To get the environment variable bindings, this method should be called in prefer togetJobContext().envVars()
. In the pipeline environment, the environment variables returned fromgetJobContext().envVars()
is not complete. The default implementation of this method inBaseCommandContext
handles this.
-
-