org.apache.uima.ducc.cli
Class DuccJobCancel
java.lang.Object
org.apache.uima.ducc.cli.CliBase
org.apache.uima.ducc.cli.DuccJobCancel
- All Implemented Interfaces:
- org.apache.uima.ducc.cli.IUiOptions
public class DuccJobCancel
- extends CliBase
Cancel a DUCC job
Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions |
org.apache.uima.ducc.cli.IUiOptions.ClasspathOrderParms, org.apache.uima.ducc.cli.IUiOptions.UiOption |
Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions |
help_width |
Method Summary |
boolean |
execute()
Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator
to effect the cancelation. |
long |
getCanceledPid()
If a specific process, rather than the entire job, is canceled. |
String |
getResponseMessage()
Return the DUCC Orchestrator message, if any, pertaining to the cancelation. |
static void |
main(String[] args)
Main method, as used by the executable jar or direct java invocation. |
DuccJobCancel
public DuccJobCancel(String[] args)
throws Exception
- Parameters:
args
- Array of string arguments as described in the
DUCC CLI reference.
- Throws:
Exception
DuccJobCancel
public DuccJobCancel(List<String> args)
throws Exception
- Parameters:
args
- List of string arguments as described in the
DUCC CLI reference.
- Throws:
Exception
DuccJobCancel
public DuccJobCancel(Properties props)
throws Exception
- Parameters:
props
- Properties file of arguments, as described in the
DUCC CLI reference.
- Throws:
Exception
getCanceledPid
public long getCanceledPid()
- If a specific process, rather than the entire job, is canceled. this returns the canceled
DUCC id of the process, as confirmation.
- Returns:
- The DUCC numeric id of the canceled process.
getResponseMessage
public String getResponseMessage()
- Return the DUCC Orchestrator message, if any, pertaining to the cancelation.
- Returns:
- Return any message associated with the cancelation.
execute
public boolean execute()
throws Exception
- Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator
to effect the cancelation.
- Specified by:
execute
in class CliBase
- Returns:
- True if the orchestrator accepts the job cancelation.
- Throws:
Exception
- The specific exception is a function of the implementor.
main
public static void main(String[] args)
- Main method, as used by the executable jar or direct java invocation.
- Parameters:
args
- arguments as described in the DUCC CLI reference.
Copyright © 2012–2014 The Apache Software Foundation. All rights reserved.