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 2016/08/08 19:58:35 UTC

svn commit: r1755532 [7/24] - in /uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.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-2.1.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html?rev=1755532&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html (added)
+++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html Mon Aug  8 19:58:33 2016
@@ -0,0 +1,494 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>DuccReservationSubmit (Apache UIMA DUCC Java SDK 2.1.0 								User-Level API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="DuccReservationSubmit (Apache UIMA DUCC Java SDK 2.1.0 								User-Level API Documentation)";
+    }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!--   -->
+</a>
+<div class="skip"><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="strong">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="strong">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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 class="header">
+<div class="subTitle">org.apache.uima.ducc.cli</div>
+<h2 title="Class DuccReservationSubmit" class="title">Class DuccReservationSubmit</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/7/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="strong">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&nbsp;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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd">&nbsp;</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><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#opts">opts</a></strong></code>&nbsp;</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><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#requestProperties">requestProperties</a></strong></code>&nbsp;</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><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#resCB">resCB</a></strong></code>&nbsp;</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&nbsp;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&nbsp;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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.util.ArrayList)">DuccReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;args)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.util.Properties)">DuccReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.lang.String[])">DuccReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!--   -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#execute()">execute</a></strong>()</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 class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHost()">getHost</a></strong>()</code>
+<div class="block">If the reservation is granted, this method returns the reserved host</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHosts()">getHosts</a></strong>()</code>
+<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHostsAsString()">getHostsAsString</a></strong>()</code>
+<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html#main(java.lang.String[])">main</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;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&nbsp;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()">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode()">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults()">inhibitDef
 aults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String, org.apache.uima.ducc.cli.IUiOption[], java.lang.String[], 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[], 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[], java.lang.String[], org.apache.uima.ducc.common.utils.DuccProperties, org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListener()">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[], boolean)">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions(org.apache.uima.ducc.cli.IUiOption[])">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="../../../../../org/apache/uima/ducc/cli/CliBase.html#setWorkingDirectory()">setWorkingDirectory</a>, <a href="../../../../../
 org/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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public&nbsp;DuccReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
+                      throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of string arguments as described in the 
+      <a href="/doc/duccbook.html#DUCC_CLI_RESERVE">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
+</li>
+</ul>
+<a name="DuccReservationSubmit(java.util.ArrayList)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public&nbsp;DuccReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;args)
+                      throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - List of string arguments as described in the 
+      <a href="/doc/duccbook.html#DUCC_CLI_RESERVE">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
+</li>
+</ul>
+<a name="DuccReservationSubmit(java.util.Properties)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DuccReservationSubmit</h4>
+<pre>public&nbsp;DuccReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)
+                      throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - Properties file of arguments, as described in the
+      <a href="/doc/duccbook.html#DUCC_CLI_RESERVE">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></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&nbsp;boolean&nbsp;execute()
+                throws <a href="http://docs.oracle.com/javase/7/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><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute()">execute</a></code>&nbsp;in class&nbsp;<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="strong">Returns:</span></dt><dd>True if the DUCC grants the reservation.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
+</li>
+</ul>
+<a name="getHost()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHost</h4>
+<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHost()</pre>
+<div class="block">If the reservation is granted, this method returns the reserved host</div>
+<dl><dt><span class="strong">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/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getHosts()</pre>
+<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
+<div class="block">If the reservation is granted, this method returns the set of hosts containing the reservation.</div>
+<dl><dt><span class="strong">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/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHostsAsString()</pre>
+<div class="block"><span class="strong">Deprecated.</span>&nbsp;</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="strong">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>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static&nbsp;void&nbsp;main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</pre>
+<div class="block">Main method, as used by the executable jar or direct java invocation.</div>
+<dl><dt><span class="strong">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 class="bottomNav"><a name="navbar_bottom">
+<!--   -->
+</a>
+<div class="skip"><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="strong">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="strong">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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2016 <a href="http://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-2.1.0/api/org/apache/uima/ducc/cli/DuccReservationSubmit.html
------------------------------------------------------------------------------
    svn:eol-style = native