You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by xi...@apache.org on 2016/10/19 17:21:45 UTC
svn commit: r1765686 [35/42] - in /samza/site: ./ archive/ community/
contribute/ img/0.11/ img/0.11/learn/ img/0.11/learn/documentation/
img/0.11/learn/documentation/comparisons/
img/0.11/learn/documentation/container/ img/0.11/learn/documentation/int...
Added: samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/AbstractJobProxy.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/AbstractJobProxy.html?rev=1765686&view=auto
==============================================================================
--- samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/AbstractJobProxy.html (added)
+++ samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/AbstractJobProxy.html Wed Oct 19 17:21:41 2016
@@ -0,0 +1,489 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_40) on Wed Oct 19 10:20:42 PDT 2016 -->
+<title>AbstractJobProxy (samza-rest 0.11.0 API)</title>
+<meta name="date" content="2016-10-19">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="AbstractJobProxy (samza-rest 0.11.0 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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>Prev Class</li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/AbstractJobProxy.html" target="_top">Frames</a></li>
+<li><a href="AbstractJobProxy.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.samza.rest.proxy.job</div>
+<h2 title="Class AbstractJobProxy" class="title">Class AbstractJobProxy</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.rest.proxy.job.AbstractJobProxy</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></dd>
+</dl>
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="typeNameLabel">AbstractJobProxy</span>
+extends java.lang.Object
+implements <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></pre>
+<div class="block">Implements a subset of the <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> interface with the default, cluster-agnostic,
+ implementations. Subclasses are expected to override these default methods where necessary.</div>
+</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#config">config</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#AbstractJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">AbstractJobProxy</a></span>(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</code>
+<div class="block">Required constructor.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-">fromFactory</a></span>(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</code>
+<div class="block">Creates a new JobProxy instance from the factory class specified in the config.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>protected abstract java.util.Set<<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobInstances--">getAllJobInstances</a></span>()</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobStatuses--">getAllJobStatuses</a></span>()</code> </td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>protected org.apache.samza.config.ConfigFactory</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobConfigFactory--">getJobConfigFactory</a></span>()</code> </td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../../../org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobSamzaStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobSamzaStatus</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code>
+<div class="block">Convenience method to get the Samza job status from the name and id.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code> </td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatusProvider--">getJobStatusProvider</a></span>()</code> </td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</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.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.rest.proxy.job.JobProxy">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></h3>
+<code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#start-org.apache.samza.rest.proxy.job.JobInstance-">start</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#stop-org.apache.samza.rest.proxy.job.JobInstance-">stop</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="config">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>config</h4>
+<pre>protected final <a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="AbstractJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>AbstractJobProxy</h4>
+<pre>public AbstractJobProxy(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</pre>
+<div class="block">Required constructor.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>config</code> - the config containing the installations path.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>fromFactory</h4>
+<pre>public static <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a> fromFactory(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</pre>
+<div class="block">Creates a new JobProxy instance from the factory class specified in the config.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>config</code> - the config containing the job proxy factory property.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the JobProxy produced by the factory.</dd>
+</dl>
+</li>
+</ul>
+<a name="getAllJobStatuses--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllJobStatuses</h4>
+<pre>public java.util.List<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>> getAllJobStatuses()
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#getAllJobStatuses--">getAllJobStatuses</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for each Samza job instance installed on this host.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobSamzaStatus-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobSamzaStatus</h4>
+<pre>protected <a href="../../../../../../org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a> getJobSamzaStatus(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<div class="block">Convenience method to get the Samza job status from the name and id.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the current Samza status for the job.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobStatus</h4>
+<pre>public <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a> getJobStatus(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job for which the status is needed.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> containing
+ the status for the job specified by jobName and jobId.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="jobExists-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>jobExists</h4>
+<pre>public boolean jobExists(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the job exists and can be started, stopped, etc.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobConfigFactory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobConfigFactory</h4>
+<pre>protected org.apache.samza.config.ConfigFactory getJobConfigFactory()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <code>ConfigFactory</code> to use to read job configuration files.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobStatusProvider--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobStatusProvider</h4>
+<pre>protected abstract <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a> getJobStatusProvider()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobStatusProvider</code></a> to use in retrieving the job status.</dd>
+</dl>
+</li>
+</ul>
+<a name="getAllJobInstances--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getAllJobInstances</h4>
+<pre>protected abstract java.util.Set<<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a>> getAllJobInstances()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>all available job instances.</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="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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>Prev Class</li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/AbstractJobProxy.html" target="_top">Frames</a></li>
+<li><a href="AbstractJobProxy.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 ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobInstance.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobInstance.html?rev=1765686&view=auto
==============================================================================
--- samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobInstance.html (added)
+++ samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobInstance.html Wed Oct 19 17:21:41 2016
@@ -0,0 +1,356 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_40) on Wed Oct 19 10:20:42 PDT 2016 -->
+<title>JobInstance (samza-rest 0.11.0 API)</title>
+<meta name="date" content="2016-10-19">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="JobInstance (samza-rest 0.11.0 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobInstance.html" target="_top">Frames</a></li>
+<li><a href="JobInstance.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.samza.rest.proxy.job</div>
+<h2 title="Class JobInstance" class="title">Class JobInstance</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.rest.proxy.job.JobInstance</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">JobInstance</span>
+extends java.lang.Object</pre>
+<div class="block">Allows us to encapsulate the jobName,jobId tuple as one entity.</div>
+</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#JobInstance-java.lang.String-java.lang.String-">JobInstance</a></span>(java.lang.String jobName,
+ java.lang.String jobId)</code>
+<div class="block">Required constructor.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#getJobId--">getJobId</a></span>()</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#getJobName--">getJobName</a></span>()</code> </td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#hashCode--">hashCode</a></span>()</code> </td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html#toString--">toString</a></span>()</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.Object</h3>
+<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="JobInstance-java.lang.String-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>JobInstance</h4>
+<pre>public JobInstance(java.lang.String jobName,
+ java.lang.String jobId)</pre>
+<div class="block">Required constructor.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobName</code> - the name of the job.</dd>
+<dd><code>jobId</code> - the id of the job.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getJobName--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobName</h4>
+<pre>public java.lang.String getJobName()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the name of the job.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobId--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobId</h4>
+<pre>public java.lang.String getJobId()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the id of the job.</dd>
+</dl>
+</li>
+</ul>
+<a name="hashCode--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hashCode</h4>
+<pre>public int hashCode()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="equals-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>equals</h4>
+<pre>public boolean equals(java.lang.Object other)</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code> in class <code>java.lang.Object</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="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobInstance.html" target="_top">Frames</a></li>
+<li><a href="JobInstance.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 ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html?rev=1765686&view=auto
==============================================================================
--- samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html (added)
+++ samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html Wed Oct 19 17:21:41 2016
@@ -0,0 +1,329 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_40) on Wed Oct 19 10:20:42 PDT 2016 -->
+<title>JobProxy (samza-rest 0.11.0 API)</title>
+<meta name="date" content="2016-10-19">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="JobProxy (samza-rest 0.11.0 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobProxy.html" target="_top">Frames</a></li>
+<li><a href="JobProxy.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.rest.proxy.job</div>
+<h2 title="Interface JobProxy" class="title">Interface JobProxy</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">AbstractJobProxy</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html" title="class in org.apache.samza.rest.proxy.job">SimpleYarnJobProxy</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">JobProxy</span></pre>
+<div class="block">Job proxy is the primary abstraction used by the REST API to interact with jobs.
+
+ Concrete implementations of this interface may vary in the APIs they use to discover, start, stop, and stat jobs,
+ how to interact with the installed jobs on disk, etc.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#getAllJobStatuses--">getAllJobStatuses</a></span>()</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code> </td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#start-org.apache.samza.rest.proxy.job.JobInstance-">start</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code>
+<div class="block">Starts the job instance specified by jobName and jobId.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#stop-org.apache.samza.rest.proxy.job.JobInstance-">stop</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code>
+<div class="block">Stops the job instance specified by jobName and jobId.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="jobExists-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>jobExists</h4>
+<pre>boolean jobExists(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the job exists and can be started, stopped, etc.</dd>
+</dl>
+</li>
+</ul>
+<a name="getAllJobStatuses--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllJobStatuses</h4>
+<pre>java.util.List<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>> getAllJobStatuses()
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for each Samza job instance installed on this host.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobStatus</h4>
+<pre><a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a> getJobStatus(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job for which the status is needed.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> containing
+ the status for the job specified by jobName and jobId.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="start-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>void start(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.lang.Exception</pre>
+<div class="block">Starts the job instance specified by jobName and jobId. When this method returns, the status of the job
+ should be <a href="../../../../../../org/apache/samza/rest/model/JobStatus.html#STARTING"><code>JobStatus.STARTING</code></a> or
+ <a href="../../../../../../org/apache/samza/rest/model/JobStatus.html#STARTED"><code>JobStatus.STARTED</code></a> depending on the implementation.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job to start.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.Exception</code> - if the job could not be successfully started.</dd>
+</dl>
+</li>
+</ul>
+<a name="stop-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>stop</h4>
+<pre>void stop(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.lang.Exception</pre>
+<div class="block">Stops the job instance specified by jobName and jobId. When this method returns, the status of the job
+ should be <a href="../../../../../../org/apache/samza/rest/model/JobStatus.html#STOPPED"><code>JobStatus.STOPPED</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job to stop.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.Exception</code> - if the job could not be successfully stopped.</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="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobProxy.html" target="_top">Frames</a></li>
+<li><a href="JobProxy.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html?rev=1765686&view=auto
==============================================================================
--- samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html (added)
+++ samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html Wed Oct 19 17:21:41 2016
@@ -0,0 +1,238 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_40) on Wed Oct 19 10:20:42 PDT 2016 -->
+<title>JobProxyFactory (samza-rest 0.11.0 API)</title>
+<meta name="date" content="2016-10-19">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="JobProxyFactory (samza-rest 0.11.0 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobProxyFactory.html" target="_top">Frames</a></li>
+<li><a href="JobProxyFactory.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.rest.proxy.job</div>
+<h2 title="Interface JobProxyFactory" class="title">Interface JobProxyFactory</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job">SimpleYarnJobProxyFactory</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">JobProxyFactory</span></pre>
+<div class="block">Simple factory interface to produce instances of <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a>,
+ depending on the implementation.
+
+ To use a custom <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a>, create an implementation of that interface, an implementation
+ of this interface which instantiates the custom proxy and finally reference the custom factory
+ in the config <a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_PROXY_FACTORY"><code>JobsResourceConfig.CONFIG_JOB_PROXY_FACTORY</code></a>.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html#getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">getJobProxy</a></span>(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</code>
+<div class="block">Creates a new <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> and initializes it with the specified config.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getJobProxy</h4>
+<pre><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a> getJobProxy(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</pre>
+<div class="block">Creates a new <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> and initializes it with the specified config.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>config</code> - the <a href="../../../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest"><code>SamzaRestConfig</code></a> to pass to the proxy.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the created proxy.</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="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobProxyFactory.html" target="_top">Frames</a></li>
+<li><a href="JobProxyFactory.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html?rev=1765686&view=auto
==============================================================================
--- samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html (added)
+++ samza/site/learn/documentation/0.11/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html Wed Oct 19 17:21:41 2016
@@ -0,0 +1,261 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_40) on Wed Oct 19 10:20:42 PDT 2016 -->
+<title>JobStatusProvider (samza-rest 0.11.0 API)</title>
+<meta name="date" content="2016-10-19">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="JobStatusProvider (samza-rest 0.11.0 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobStatusProvider.html" target="_top">Frames</a></li>
+<li><a href="JobStatusProvider.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.rest.proxy.job</div>
+<h2 title="Interface JobStatusProvider" class="title">Interface JobStatusProvider</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../../org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html" title="class in org.apache.samza.rest.proxy.job">YarnCliJobStatusProvider</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">JobStatusProvider</span></pre>
+<div class="block">Interface for getting job status independent of the underlying cluster implementation.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatuses-java.util.Collection-">getJobStatuses</a></span>(java.util.Collection<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>> jobs)</code>
+<div class="block">Populates the status* fields of each <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> in the provided Collection.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getJobStatuses-java.util.Collection-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getJobStatuses</h4>
+<pre>void getJobStatuses(java.util.Collection<<a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a>> jobs)
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<div class="block">Populates the status* fields of each <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> in the provided Collection.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobs</code> - the collection of <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for which the status is needed.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</dd>
+</dl>
+</li>
+</ul>
+<a name="getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getJobStatus</h4>
+<pre><a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a> getJobStatus(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)
+ throws java.io.IOException,
+ java.lang.InterruptedException</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jobInstance</code> - the instance of the job.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="../../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> containing
+ the status for the job specified by jobName and jobId.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if there was a problem executing the command to get the status.</dd>
+<dd><code>java.lang.InterruptedException</code> - if the thread was interrupted while waiting for the status result.</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="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/JobStatusProvider.html" target="_top">Frames</a></li>
+<li><a href="JobStatusProvider.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>Constr | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>