Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html?rev=1784198&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html (added) +++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html Thu Feb 23 19:30:22 2017 @@ -0,0 +1,571 @@ +<!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>RmQueriedMachine (Apache UIMA DUCC Java SDK 2.2.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="RmQueriedMachine (Apache UIMA DUCC Java SDK 2.2.0 \t\t\t\t\t\t\t\tUser-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/RmQueriedMachine.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/common/admin/event/RmQueriedClass.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html" target="_top">Frames</a></li> +<li><a href="RmQueriedMachine.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 class="header"> +<div class="subTitle">org.apache.uima.ducc.common.admin.event</div> +<h2 title="Class RmQueriedMachine" class="title">Class RmQueriedMachine</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>org.apache.uima.ducc.common.admin.event.RmQueriedMachine</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RmQueriedMachine</span> +extends <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> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">This object represents details of a host as seen by the Resource Manager.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../serialized-form.html#org.apache.uima.ducc.common.admin.event.RmQueriedMachine">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== 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"> </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) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#blacklisted">blacklisted</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#memory">memory</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) <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/common/admin/event/RmQueriedMachine.html#name">name</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) <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/common/admin/event/RmQueriedMachine.html#nodepoolId">nodepoolId</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#online">online</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#order">order</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#responsive">responsive</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#shares">shares</a></strong></code> </td> +</tr> +</table> +</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"> </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/common/admin/event/RmQueriedMachine.html#RmQueriedMachine(java.lang.String,%20java.lang.String,%20long,%20int,%20boolean)">RmQueriedMachine</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> name, + <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> nodepoolId, + long memory, + int order, + boolean blacklisted)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#addShare(org.apache.uima.ducc.common.admin.event.RmQueriedShare)">addShare</a></strong>(<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a> rqs)</code> </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/common/admin/event/RmQueriedMachine.html#getId()">getId</a></strong>()</code> +<div class="block">Returns the name of the machin.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getMemory()">getMemory</a></strong>()</code> +<div class="block">Returns the amount of RAM in KB (kilobytes) on the machine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getShareOrder()">getShareOrder</a></strong>()</code> +<div class="block">Returns the share order of the machine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getShares()">getShares</a></strong>()</code> +<div class="block">Return the list of shares scheduled to this host.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#isBlacklisted()">isBlacklisted</a></strong>()</code> +<div class="block">Returns whether the machine is blacklisted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#isOnline()">isOnline</a></strong>()</code> +<div class="block">Returns whether the machine is varied online.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#isResponsive()">isResponsive</a></strong>()</code> +<div class="block">Indicates whether the machine is sending heartbeats.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#setOffline()">setOffline</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#setUnresponsive()">setUnresponsive</a></strong>()</code> </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/common/admin/event/RmQueriedMachine.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<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/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#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,%20int)" 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="name"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>name</h4> +<pre><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> name</pre> +</li> +</ul> +<a name="nodepoolId"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nodepoolId</h4> +<pre><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> nodepoolId</pre> +</li> +</ul> +<a name="memory"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>memory</h4> +<pre>long memory</pre> +</li> +</ul> +<a name="order"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>order</h4> +<pre>int order</pre> +</li> +</ul> +<a name="blacklisted"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>blacklisted</h4> +<pre>boolean blacklisted</pre> +</li> +</ul> +<a name="online"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>online</h4> +<pre>boolean online</pre> +</li> +</ul> +<a name="responsive"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>responsive</h4> +<pre>boolean responsive</pre> +</li> +</ul> +<a name="shares"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shares</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a>> shares</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RmQueriedMachine(java.lang.String, java.lang.String, long, int, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RmQueriedMachine</h4> +<pre>public RmQueriedMachine(<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> name, + <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> nodepoolId, + long memory, + int order, + boolean blacklisted)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setOffline()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOffline</h4> +<pre>public void setOffline()</pre> +</li> +</ul> +<a name="setUnresponsive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUnresponsive</h4> +<pre>public void setUnresponsive()</pre> +</li> +</ul> +<a name="addShare(org.apache.uima.ducc.common.admin.event.RmQueriedShare)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addShare</h4> +<pre>public void addShare(<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a> rqs)</pre> +</li> +</ul> +<a name="getShares()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShares</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a>> getShares()</pre> +<div class="block">Return the list of shares scheduled to this host.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The list of <a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event"><code>shares</code></a>.</dd></dl> +</li> +</ul> +<a name="getId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public <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> getId()</pre> +<div class="block">Returns the name of the machin.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the machine.</dd></dl> +</li> +</ul> +<a name="getMemory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMemory</h4> +<pre>public long getMemory()</pre> +<div class="block">Returns the amount of RAM in KB (kilobytes) on the machine.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the amount of RAM in the machine, in kilobytes.</dd></dl> +</li> +</ul> +<a name="getShareOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShareOrder</h4> +<pre>public int getShareOrder()</pre> +<div class="block">Returns the share order of the machine.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of quantum shares supported by the machine. For example, if the share quantum is + 15GB, a 48GB machine is of order 3.</dd></dl> +</li> +</ul> +<a name="isBlacklisted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBlacklisted</h4> +<pre>public boolean isBlacklisted()</pre> +<div class="block">Returns whether the machine is blacklisted.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>whether the host contains blacklisted processes. A blacklisted process is one whose characteristics + no longer match the machine. For example, after reconfiguration, this may be an illegal assignemnt + for the request. Until such time as the request is (externally) removed, the RM has to account for + the space by maintaining records on the blacklisted work. If a machine is blacklisted, it is not + schedulable for new work.</dd></dl> +</li> +</ul> +<a name="isOnline()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOnline</h4> +<pre>public boolean isOnline()</pre> +<div class="block">Returns whether the machine is varied online.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the machine is varied online and false otherwise. Note that a machine might "not varied offline", + but not responsive (not sending heartbeats).</dd></dl> +</li> +</ul> +<a name="isResponsive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isResponsive</h4> +<pre>public boolean isResponsive()</pre> +<div class="block">Indicates whether the machine is sending heartbeats.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the machine is sending heartbeats. Note that a machine might be sending heartbeats but be varied + offline or blacklisted, and hence not schedulable.</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></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/RmQueriedMachine.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/common/admin/event/RmQueriedClass.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html" target="_top">Frames</a></li> +<li><a href="RmQueriedMachine.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 ======= --> +<p class="legalCopy"><small>Copyright © 2012–2017 <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.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html ------------------------------------------------------------------------------ svn:eol-style = native Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html?rev=1784198&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html (added) +++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html Thu Feb 23 19:30:22 2017 @@ -0,0 +1,554 @@ +<!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>RmQueriedNodepool (Apache UIMA DUCC Java SDK 2.2.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="RmQueriedNodepool (Apache UIMA DUCC Java SDK 2.2.0 \t\t\t\t\t\t\t\tUser-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/RmQueriedNodepool.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/common/admin/event/RmQueriedMachine.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html" target="_top">Frames</a></li> +<li><a href="RmQueriedNodepool.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>Field | </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>Field | </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 class="header"> +<div class="subTitle">org.apache.uima.ducc.common.admin.event</div> +<h2 title="Class RmQueriedNodepool" class="title">Class RmQueriedNodepool</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>org.apache.uima.ducc.common.admin.event.RmQueriedNodepool</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RmQueriedNodepool</span> +extends <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> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">This class returns details about the current state of each nodepool. + + Regarding the <code>getFreeMachines</code> and <code>getVirtualMachines</code> calls, these + two arrays together show the available memory that is free and schedulable. For example, if + a 48GB machine has a 15GB process scheduled on it (assuming a share quantum of 15GB), the + response will show one 30GB virtual machine, and the expected count of 48GB machines will be + reduced by one.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../serialized-form.html#org.apache.uima.ducc.common.admin.event.RmQueriedNodepool">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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"> </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/common/admin/event/RmQueriedNodepool.html#RmQueriedNodepool()">RmQueriedNodepool</a></strong>()</code> +<div class="block">Used by RM only.</div> +</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"> </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>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getAllMachines()">getAllMachines</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getDead()">getDead</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getFreeMachines()">getFreeMachines</a></strong>()</code> </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/common/admin/event/RmQueriedNodepool.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOffline()">getOffline</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOnline()">getOnline</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOnlineMachines()">getOnlineMachines</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getSharesAvailable()">getSharesAvailable</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getSharesFree()">getSharesFree</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getVirtualMachines()">getVirtualMachines</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setAllMachines(int[])">setAllMachines</a></strong>(int[] allMachines)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setDead(int)">setDead</a></strong>(int dead)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setFreeMachines(int[])">setFreeMachines</a></strong>(int[] freeMachines)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setName(java.lang.String)">setName</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> name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setOffline(int)">setOffline</a></strong>(int offline)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setOnline(int)">setOnline</a></strong>(int online)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setOnlineMachines(int[])">setOnlineMachines</a></strong>(int[] onlineMachines)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setSharesAvailable(int)">setSharesAvailable</a></strong>(int sharesAvailable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setSharesFree(int)">setSharesFree</a></strong>(int sharesFree)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#setVirtualMachines(int[])">setVirtualMachines</a></strong>(int[] virtualMachines)</code> </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/common/admin/event/RmQueriedNodepool.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<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/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#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,%20int)" 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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RmQueriedNodepool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RmQueriedNodepool</h4> +<pre>public RmQueriedNodepool()</pre> +<div class="block">Used by RM only.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <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> getName()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the nodepool</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<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> name)</pre> +</li> +</ul> +<a name="getOnline()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOnline</h4> +<pre>public int getOnline()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of online, schedulable hosts in the nodepool.</dd></dl> +</li> +</ul> +<a name="setOnline(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOnline</h4> +<pre>public void setOnline(int online)</pre> +</li> +</ul> +<a name="getDead()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDead</h4> +<pre>public int getDead()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of hosts which once were responding but have stopped sending heartbeats.</dd></dl> +</li> +</ul> +<a name="setDead(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDead</h4> +<pre>public void setDead(int dead)</pre> +</li> +</ul> +<a name="getOffline()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOffline</h4> +<pre>public int getOffline()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of hosts which are varied offline.</dd></dl> +</li> +</ul> +<a name="setOffline(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOffline</h4> +<pre>public void setOffline(int offline)</pre> +</li> +</ul> +<a name="getSharesAvailable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSharesAvailable</h4> +<pre>public int getSharesAvailable()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the total number of schedulable quantum shares in the nodepool.</dd></dl> +</li> +</ul> +<a name="setSharesAvailable(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSharesAvailable</h4> +<pre>public void setSharesAvailable(int sharesAvailable)</pre> +</li> +</ul> +<a name="getSharesFree()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSharesFree</h4> +<pre>public int getSharesFree()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of unused quantum shares in the nodepool.</dd></dl> +</li> +</ul> +<a name="setSharesFree(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSharesFree</h4> +<pre>public void setSharesFree(int sharesFree)</pre> +</li> +</ul> +<a name="getAllMachines()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllMachines</h4> +<pre>public int[] getAllMachines()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array, indexed by multiples of the share quantum, showing the total number of machines + known to the nodepool, regardless of status, whose memory capacity matches that multiple of the quantum.</dd></dl> +</li> +</ul> +<a name="setAllMachines(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllMachines</h4> +<pre>public void setAllMachines(int[] allMachines)</pre> +</li> +</ul> +<a name="getOnlineMachines()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOnlineMachines</h4> +<pre>public int[] getOnlineMachines()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array, indexed by multiples of the share quantum, showing the total number of machines + which are online and schedulable whose memory capacity matches that multiple of the quantum.</dd></dl> +</li> +</ul> +<a name="setOnlineMachines(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOnlineMachines</h4> +<pre>public void setOnlineMachines(int[] onlineMachines)</pre> +</li> +</ul> +<a name="getFreeMachines()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFreeMachines</h4> +<pre>public int[] getFreeMachines()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array, indexed by multiples of the share quantum, showing the total number of physical + machines which have nothing scheduled on them.</dd></dl> +</li> +</ul> +<a name="setFreeMachines(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFreeMachines</h4> +<pre>public void setFreeMachines(int[] freeMachines)</pre> +</li> +</ul> +<a name="getVirtualMachines()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVirtualMachines</h4> +<pre>public int[] getVirtualMachines()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array, indexed by multiples of the share quantum, showing the total number of + shares free on machines that to have something scheduled on them.</dd></dl> +</li> +</ul> +<a name="setVirtualMachines(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVirtualMachines</h4> +<pre>public void setVirtualMachines(int[] virtualMachines)</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></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/RmQueriedNodepool.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/common/admin/event/RmQueriedMachine.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html" target="_top">Frames</a></li> +<li><a href="RmQueriedNodepool.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>Field | </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>Field | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2012–2017 <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.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html ------------------------------------------------------------------------------ svn:eol-style = native Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedShare.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedShare.html?rev=1784198&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedShare.html (added) +++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedShare.html Thu Feb 23 19:30:22 2017 @@ -0,0 +1,639 @@ +<!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>RmQueriedShare (Apache UIMA DUCC Java SDK 2.2.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="RmQueriedShare (Apache UIMA DUCC Java SDK 2.2.0 \t\t\t\t\t\t\t\tUser-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/RmQueriedShare.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/common/admin/event/RmQueriedNodepool.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" target="_top">Frames</a></li> +<li><a href="RmQueriedShare.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 class="header"> +<div class="subTitle">org.apache.uima.ducc.common.admin.event</div> +<h2 title="Class RmQueriedShare" class="title">Class RmQueriedShare</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>org.apache.uima.ducc.common.admin.event.RmQueriedShare</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RmQueriedShare</span> +extends <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> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">This object returns details about every unit of scheduled work in the sysmte.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../serialized-form.html#org.apache.uima.ducc.common.admin.event.RmQueriedShare">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== 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"> </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) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#blacklisted">blacklisted</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#evicted">evicted</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#fixed">fixed</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#initialized">initialized</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#investmentInit">investmentInit</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#investmentRt">investmentRt</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#jobId">jobId</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#order">order</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#purged">purged</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#shareId">shareId</a></strong></code> </td> +</tr> +</table> +</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"> </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/common/admin/event/RmQueriedShare.html#RmQueriedShare(long,%20long,%20int,%20long,%20long)">RmQueriedShare</a></strong>(long job_id, + long share_id, + int order, + long investment_init, + long investment_rt)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getId()">getId</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getInvestmentInit()">getInvestmentInit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getInvestmentRt()">getInvestmentRt</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getJobId()">getJobId</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getShareOrder()">getShareOrder</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#isEvicted()">isEvicted</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#isFixed()">isFixed</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#isInitialized()">isInitialized</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#isPurged()">isPurged</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#setBlacklisted()">setBlacklisted</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#setEvicted(boolean)">setEvicted</a></strong>(boolean v)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#setFixed(boolean)">setFixed</a></strong>(boolean v)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#setInitialized(boolean)">setInitialized</a></strong>(boolean v)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#setPurged(boolean)">setPurged</a></strong>(boolean v)</code> </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/common/admin/event/RmQueriedShare.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<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/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#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,%20int)" 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="jobId"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>jobId</h4> +<pre>long jobId</pre> +</li> +</ul> +<a name="shareId"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shareId</h4> +<pre>long shareId</pre> +</li> +</ul> +<a name="investmentInit"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>investmentInit</h4> +<pre>long investmentInit</pre> +</li> +</ul> +<a name="investmentRt"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>investmentRt</h4> +<pre>long investmentRt</pre> +</li> +</ul> +<a name="order"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>order</h4> +<pre>int order</pre> +</li> +</ul> +<a name="evicted"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evicted</h4> +<pre>boolean evicted</pre> +</li> +</ul> +<a name="purged"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>purged</h4> +<pre>boolean purged</pre> +</li> +</ul> +<a name="fixed"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fixed</h4> +<pre>boolean fixed</pre> +</li> +</ul> +<a name="initialized"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialized</h4> +<pre>boolean initialized</pre> +</li> +</ul> +<a name="blacklisted"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>blacklisted</h4> +<pre>boolean blacklisted</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RmQueriedShare(long, long, int, long, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RmQueriedShare</h4> +<pre>public RmQueriedShare(long job_id, + long share_id, + int order, + long investment_init, + long investment_rt)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setEvicted(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEvicted</h4> +<pre>public void setEvicted(boolean v)</pre> +</li> +</ul> +<a name="setPurged(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPurged</h4> +<pre>public void setPurged(boolean v)</pre> +</li> +</ul> +<a name="setFixed(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFixed</h4> +<pre>public void setFixed(boolean v)</pre> +</li> +</ul> +<a name="setInitialized(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialized</h4> +<pre>public void setInitialized(boolean v)</pre> +</li> +</ul> +<a name="setBlacklisted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlacklisted</h4> +<pre>public void setBlacklisted()</pre> +</li> +</ul> +<a name="getJobId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobId</h4> +<pre>public long getJobId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the numeric ID of the request, as assigned by the Orchestrator. Note that many + shares may have the same job id, if the work is scaled-out in thecluster.</dd></dl> +</li> +</ul> +<a name="getId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public long getId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the unique ID of the scheduled work, as assigned by the RM. If a job is scaled out, + its processes will have the same JobId, but a different share ID as returned by this method.</dd></dl> +</li> +</ul> +<a name="getInvestmentInit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInvestmentInit</h4> +<pre>public long getInvestmentInit()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the initialization investment, in millliseconds. This is the amount of time spent thus far + by the processes in its initialization phase.</dd></dl> +</li> +</ul> +<a name="getInvestmentRt()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInvestmentRt</h4> +<pre>public long getInvestmentRt()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the runtime investment, in milliseconds. This is the sum of the time spent by each thread + in the processes, <em>on its current CAS</em>. When the work represented by a CAS is + completed, the thread contributes nothing to the investment until (or unless) it starts + the process a new CAS. The runtime investment is a heuristic used by the RM to determine + which processes would lose the least amount of work if it was preempted. + + Note that as of DUCC 2.0.0, a thread may request a reset of its investment, e.g. after + it has checkpointed, allowing for very long-running CASs while still providing an accurate + reflection of its investment.</dd></dl> +</li> +</ul> +<a name="getShareOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShareOrder</h4> +<pre>public int getShareOrder()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the share-order of the processes. This is the number of quantum shares occupied by each + processes in the job. For example, if the quantum is 15GB a 45GB process is an <em>order 3</em> + process.</dd></dl> +</li> +</ul> +<a name="isEvicted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEvicted</h4> +<pre>public boolean isEvicted()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the process has been preempted but the Orchestrator has not yet acknowledged that the + process has exited, and false otherwise.</dd></dl> +</li> +</ul> +<a name="isPurged()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPurged</h4> +<pre>public boolean isPurged()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the host the processes is running on has stopped responding, the RM has send a purge order + to the Orchestrator, but has not yet received confirmation that the processes has exited, and false + otherwise.</dd></dl> +</li> +</ul> +<a name="isFixed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFixed</h4> +<pre>public boolean isFixed()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true of the process is non-preemptable, and true otherwise.</dd></dl> +</li> +</ul> +<a name="isInitialized()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInitialized</h4> +<pre>public boolean isInitialized()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the process has completed its initialization phase, and false otherwise.</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></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/RmQueriedShare.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/common/admin/event/RmQueriedNodepool.html" title="class in org.apache.uima.ducc.common.admin.event"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/uima/ducc/common/admin/event/RmQueriedShare.html" target="_top">Frames</a></li> +<li><a href="RmQueriedShare.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 ======= --> +<p class="legalCopy"><small>Copyright © 2012–2017 <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.2.0/api/org/apache/uima/ducc/common/admin/event/RmQueriedShare.html ------------------------------------------------------------------------------ svn:eol-style = native