You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2019/04/25 17:32:45 UTC
svn commit: r1858151 [7/23] - in
/uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0: ./ api/ api/org/
api/org/apache/ api/org/apache/uima/ api/org/apache/uima/ducc/
api/org/apache/uima/ducc/cli/ api/org/apache/uima/ducc/cli/class-use/
api/org/apache/...
Added: uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html?rev=1858151&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html (added)
+++ uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html Thu Apr 25 17:32:43 2019
@@ -0,0 +1,498 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>DuccReservationCancel (Apache UIMA DUCC Java SDK 3.0.0 User-Level API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="DuccReservationCancel (Apache UIMA DUCC Java SDK 3.0.0 \t\t\t\t\t\t\t\tUser-Level API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/DuccReservationCancel.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationCancel.html" target="_top">Frames</a></li>
+<li><a href="DuccReservationCancel.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div role="main" title ="DuccReservationCancel" aria-labelledby ="Header1"/>
+<div class="header">
+<div class="subTitle">org.apache.uima.ducc.cli</div>
+<h2 title="Class DuccReservationCancel" class="title" id="Header1">Class DuccReservationCancel</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">org.apache.uima.ducc.cli.CliBase</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.uima.ducc.cli.DuccReservationCancel</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>org.apache.uima.ducc.cli.IUiOptions</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">DuccReservationCancel</span>
+extends <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></pre>
+<div class="block">Cancel a DUCC reservation</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>org.apache.uima.ducc.cli.IUiOptions.UiOption</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#canceledPid">canceledPid</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#opts">opts</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#requestProperties">requestProperties</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#responseMessage">responseMessage</a></span></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a>,
<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>help_width</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel-java.util.List-">DuccReservationCancel</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel-java.util.Properties-">DuccReservationCancel</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel-java.lang.String:A-">DuccReservationCancel</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#execute--">execute</a></span>()</code>
+<div class="block">Execute collects the parameters for reservation cancellation and sends them to the DUCC Orchestrator
+ to effect the cancellation.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#getResponseMessage--">getResponseMessage</a></span>()</code>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to the cancellation.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">Main method, as used by the executable jar or direct java invocation.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size-java.lang.String-">check_heap_size</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies-java.lang.String-">check_service_dependencies</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits--">consoleExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply-org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent-">extractReply</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback--">getCallback</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId--">getDuccId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory-java.lang.String-">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode--">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getWorkingDir
ectory--">getWorkingDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults--">inhibitDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOption:A-java.lang.String:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-java.lang.String-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.lang.String:A-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListene
r--">initConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#isConsoleAttached--">isConsoleAttached</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message-java.lang.String...-">message</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits-int-">monitorExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec-java.lang.String-org.apache.uima.ducc.common.utils.DuccProperties-">saveSpec</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults-org.apache.uima.ducc.cli.IUiOption:A-boolean-">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions-org.apache.uima.ducc.cli.IUiOption:A-">setOptions</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty-java.lang.String-java.lang.String-">setProperty</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser--">setUser</a>, <a href="../../../../../o
rg/apache/uima/ducc/cli/CliBase.html#startConsoleListener-boolean-">startConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitor</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors-boolean-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners--">stopListeners</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage-java.lang.String-">usage</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion--">waitForCompletion</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="requestProperties">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>requestProperties</h4>
+<pre>org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties requestProperties</pre>
+</li>
+</ul>
+<a name="canceledPid">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>canceledPid</h4>
+<pre>long canceledPid</pre>
+</li>
+</ul>
+<a name="responseMessage">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>responseMessage</h4>
+<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> responseMessage</pre>
+</li>
+</ul>
+<a name="opts">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>opts</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="DuccReservationCancel-java.lang.String:A-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationCancel</h4>
+<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - Array of string arguments as described in the</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="DuccReservationCancel-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationCancel</h4>
+<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - List of string arguments as described in the
+ Command Line Interface section of the DuccBook</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="DuccReservationCancel-java.util.Properties-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DuccReservationCancel</h4>
+<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>props</code> - Properties file of arguments, as described in the
+ Command Line Interface section of the DuccBook</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getResponseMessage--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponseMessage</h4>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResponseMessage()</pre>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to the cancellation.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Return any message associated with the cancellation.</dd>
+</dl>
+</li>
+</ul>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public boolean execute()
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Execute collects the parameters for reservation cancellation and sends them to the DUCC Orchestrator
+ to effect the cancellation.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute--">execute</a></code> in class <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>True if the orchestrator accepts the reservation cancellation.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="main-java.lang.String:A-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static void main(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
+<div class="block">Main method, as used by the executable jar or direct java invocation.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_UNRESERVE">DUCC CLI reference.</a></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/DuccReservationCancel.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationCancel.html" target="_top">Frames</a></li>
+<li><a href="DuccReservationCancel.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<div role="contentinfo" title ="contentinfo_title" aria-label ="Contains footer note"/>
+<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
Propchange: uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html?rev=1858151&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html (added)
+++ uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html Thu Apr 25 17:32:43 2019
@@ -0,0 +1,533 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>DuccReservationSubmit (Apache UIMA DUCC Java SDK 3.0.0 User-Level API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="DuccReservationSubmit (Apache UIMA DUCC Java SDK 3.0.0 \t\t\t\t\t\t\t\tUser-Level API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":42,"i3":42,"i4":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/DuccReservationSubmit.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationSubmit.html" target="_top">Frames</a></li>
+<li><a href="DuccReservationSubmit.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div role="main" title ="DuccReservationSubmit" aria-labelledby ="Header1"/>
+<div class="header">
+<div class="subTitle">org.apache.uima.ducc.cli</div>
+<h2 title="Class DuccReservationSubmit" class="title" id="Header1">Class DuccReservationSubmit</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">org.apache.uima.ducc.cli.CliBase</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.uima.ducc.cli.DuccReservationSubmit</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>org.apache.uima.ducc.cli.IUiOptions</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">DuccReservationSubmit</span>
+extends <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></pre>
+<div class="block">Submit a DUCC reservation</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>org.apache.uima.ducc.cli.IUiOptions.UiOption</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#opts">opts</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#requestProperties">requestProperties</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#resCB">resCB</a></span></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a>,
<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>help_width</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit-java.util.ArrayList-">DuccReservationSubmit</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit-java.util.Properties-">DuccReservationSubmit</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit-java.lang.String:A-">DuccReservationSubmit</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#execute--">execute</a></span>()</code>
+<div class="block">Execute collects the parameters for the reservation and sends them to the DUCC Orchestrator
+ to schedule the reservation.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHost--">getHost</a></span>()</code>
+<div class="block">If the reservation is granted, this method returns the reserved host</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHosts--">getHosts</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHostsAsString--">getHostsAsString</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">Main method, as used by the executable jar or direct java invocation.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size-java.lang.String-">check_heap_size</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies-java.lang.String-">check_service_dependencies</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits--">consoleExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply-org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent-">extractReply</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback--">getCallback</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId--">getDuccId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory-java.lang.String-">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode--">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getWorkingDir
ectory--">getWorkingDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults--">inhibitDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOption:A-java.lang.String:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-java.lang.String-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.lang.String:A-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListene
r--">initConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#isConsoleAttached--">isConsoleAttached</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message-java.lang.String...-">message</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits-int-">monitorExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec-java.lang.String-org.apache.uima.ducc.common.utils.DuccProperties-">saveSpec</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults-org.apache.uima.ducc.cli.IUiOption:A-boolean-">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions-org.apache.uima.ducc.cli.IUiOption:A-">setOptions</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty-java.lang.String-java.lang.String-">setProperty</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser--">setUser</a>, <a href="../../../../../o
rg/apache/uima/ducc/cli/CliBase.html#startConsoleListener-boolean-">startConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitor</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors-boolean-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners--">stopListeners</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage-java.lang.String-">usage</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion--">waitForCompletion</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="requestProperties">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>requestProperties</h4>
+<pre>org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties requestProperties</pre>
+</li>
+</ul>
+<a name="resCB">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>resCB</h4>
+<pre><a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> resCB</pre>
+</li>
+</ul>
+<a name="opts">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>opts</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="DuccReservationSubmit-java.lang.String:A-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public DuccReservationSubmit(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - Array of string arguments as described in the
+ Command Line Interface section of the DuccBook</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="DuccReservationSubmit-java.util.ArrayList-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public DuccReservationSubmit(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - List of string arguments as described in the
+ Command Line Interface section of the DuccBook</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="DuccReservationSubmit-java.util.Properties-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public DuccReservationSubmit(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>props</code> - Properties file of arguments, as described in the
+ Command Line Interface section of the DuccBook</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public boolean execute()
+ throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Execute collects the parameters for the reservation and sends them to the DUCC Orchestrator
+ to schedule the reservation. This method blocks until either the reservation is
+ granted, or it fails. Failure is always do to lack of resources, in some form or another.
+ Reservations must be from one of the 'reserve' classes i.e for a whole machine.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute--">execute</a></code> in class <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>True if the DUCC grants the reservation.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if request fails</dd>
+</dl>
+</li>
+</ul>
+<a name="getHost--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHost</h4>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHost()</pre>
+<div class="block">If the reservation is granted, this method returns the reserved host</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Name of host where the reservation is granted.</dd>
+</dl>
+</li>
+</ul>
+<a name="getHosts--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHosts</h4>
+<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getHosts()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">If the reservation is granted, this method returns the set of hosts containing the reservation.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>String array of hosts where the reservation is granted.</dd>
+</dl>
+</li>
+</ul>
+<a name="getHostsAsString--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHostsAsString</h4>
+<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHostsAsString()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">If the reservation is granted, this method returns the set of hosts containing the reservation as
+ a single blank-delimited string.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Blank-delimited string of hosts where the reservation is granted.</dd>
+</dl>
+</li>
+</ul>
+<a name="main-java.lang.String:A-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static void main(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
+<div class="block">Main method, as used by the executable jar or direct java invocation.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_RESERVE">DUCC CLI reference.</a></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/DuccReservationSubmit.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in org.apache.uima.ducc.cli"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationSubmit.html" target="_top">Frames</a></li>
+<li><a href="DuccReservationSubmit.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<div role="contentinfo" title ="contentinfo_title" aria-label ="Contains footer note"/>
+<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
Propchange: uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html
------------------------------------------------------------------------------
svn:eol-style = native