webgme-engine
Version:
WebGME server and Client API without a GUI
1,380 lines (342 loc) • 19.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: JobInfo</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: JobInfo</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>JobInfo<span class="signature">(parameters)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="JobInfo"><span class="type-signature"></span>new JobInfo<span class="signature">(parameters)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Class describing an executor job. The data is used for communication between the
initiator/a monitor of the job and the worker executing the job.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hash</code></td>
<td class="type">
<span class="param-type">hash</span>
</td>
<td class="description last"><p>Job identifier.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="createTime"><span class="type-signature"></span>createTime<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Timestamp of when the job was created.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="finishTime"><span class="type-signature"></span>finishTime<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Timestamp of when the job execution finished on the worker.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hash"><span class="type-signature"></span>hash<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Job identifier.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="labels"><span class="type-signature"></span>labels<span class="type-signature"> :<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span></h4>
<div class="description">
<p>Array of labels for the job.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="outputNumber"><span class="type-signature"></span>outputNumber<span class="type-signature"> :<a href="global.html#number">number</a></span></h4>
<div class="description">
<p>The (id) outputNumber (0, 1, 2, ...) of the latest <a href="OutputInfo.html">OutputInfo</a> (for this job) available on the server.
When no output is available the number is <b>null</b>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#number">number</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<h4 class="name" id="resultHashes"><span class="type-signature"></span>resultHashes<span class="type-signature"> :<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span></h4>
<div class="description">
<p>Array of hashes to <a href="Artifact.html">Artifact</a>s containing each requested result.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h4 class="name" id="resultSuperSet"><span class="type-signature"></span>resultSuperSet<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Hash to an <a href="Artifact.html">Artifact</a> containing the union of all requests results.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startTime"><span class="type-signature"></span>startTime<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Timestamp of when the job execution started by a worker.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Current status of the job.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h4 class="name" id="worker"><span class="type-signature"></span>worker<span class="type-signature"> :<a href="global.html#string">string</a></span></h4>
<div class="description">
<p>Id/label of the worker processing the job.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".finishedStatuses"><span class="type-signature">(static) </span>finishedStatuses<span class="type-signature"> :<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span></h4>
<div class="description">
<p>Array of statuses where the job hash finished and won't proceed.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".isFailedFinishedStatus"><span class="type-signature">(static) </span>isFailedFinishedStatus<span class="signature">(status)</span><span class="type-signature"> → {<a href="global.html#boolean">boolean</a>}</span></h4>
<div class="description">
<p>Returns true if the provided status is a failed finished status.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
<span class="param-type"><a href="global.html#string">string</a></span>
</td>
<td class="description last"><p>The status of a job.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#boolean">boolean</a></span>
</dd>
</dl>
<h4 class="name" id=".isFinishedStatus"><span class="type-signature">(static) </span>isFinishedStatus<span class="signature">(status)</span><span class="type-signature"> → {<a href="global.html#boolean">boolean</a>}</span></h4>
<div class="description">
<p>Returns true of the provided status is a finished status.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
<span class="param-type"><a href="global.html#string">string</a></span>
</td>
<td class="description last"><p>The status of a job.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="common_executor_JobInfo.js.html">common/executor/JobInfo.js</a>, <a href="common_executor_JobInfo.js.html#line109">line 109</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#boolean">boolean</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>