@Extension public class BuildCommand extends CLICommand
Modifier and Type | Class and Description |
---|---|
static class |
BuildCommand.CLICause |
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
protected static String |
BUILD_SCHEDULING_REFUSED |
boolean |
checkSCM |
boolean |
consoleOutput |
boolean |
follow |
Job<?,?> |
job |
Map<String,String> |
parameters |
int |
retryCnt
Deprecated.
|
boolean |
sync |
boolean |
wait |
Constructor and Description |
---|
BuildCommand() |
Modifier and Type | Method and Description |
---|---|
String |
getShortDescription()
Gets the quick summary of what this command does.
|
protected void |
printUsageSummary(PrintStream stderr)
Called while producing usage.
|
protected int |
run()
Executes the command, and return the exit code.
|
all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getSingleLineSummary, getTransportAuthentication, getTransportAuthentication2, getUsage, main, printUsage, registerOptionHandlers, setClientCharset, setTransportAuth, setTransportAuth2
public Job<?,?> job
public boolean follow
public boolean sync
public boolean wait
public boolean checkSCM
public boolean consoleOutput
@Deprecated public int retryCnt
protected static final String BUILD_SCHEDULING_REFUSED
public String getShortDescription()
CLICommand
getShortDescription
in class CLICommand
protected int run() throws Exception
CLICommand
This is an internal contract between CLICommand
and its subtype.
To execute CLI method from outside, use CLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)
run
in class CLICommand
CLICommand.run()
as a custom error code.Exception
- If a further unspecified exception is thrown; means: Unknown and/or unexpected issue occurredorg.kohsuke.args4j.CmdLineException
- If a wrong parameter specified, input value can't be decoded etc.IllegalArgumentException
- If the execution can't continue due to wrong input parameter (job doesn't exist etc.)IllegalStateException
- If the execution can't continue due to an incorrect state of Jenkins, job, build etc.AbortException
- If the execution can't continue due to an other (rare, but foreseeable) issueorg.springframework.security.access.AccessDeniedException
- If the caller doesn't have sufficient rights for requested actionorg.springframework.security.authentication.BadCredentialsException
- If bad credentials were provided to CLIprotected void printUsageSummary(PrintStream stderr)
CLICommand
printUsageSummary
in class CLICommand
Copyright © 2004–2021. All rights reserved.