com.microsoft.jenkins.azurecommons.command

Interface IBaseCommandData

All Known Implementing Classes:

BaseCommandContext

public interface IBaseCommandData

Method Summary

Modifier and Type	Method and Description
CommandState	getCommandState() Get the command state for the associated completed command.
hudson.EnvVars	getEnvVars() To get the environment variable bindings, this method should be called in prefer to getJobContext().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)

logError

void logError(String prefix,
              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

hudson.EnvVars getEnvVars()

To get the environment variable bindings, this method should be called in prefer to getJobContext().envVars(). In the pipeline environment, the environment variables returned from getJobContext().envVars() is not complete. The default implementation of this method in BaseCommandContext handles this.