Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,289 @@ +<!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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>SimpleYarnJobProxyFactory (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="SimpleYarnJobProxyFactory (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/SimpleYarnJobProxy.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/YarnCliJobStatusProvider.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/SimpleYarnJobProxyFactory.html" target="_top">Frames</a></li> +<li><a href="SimpleYarnJobProxyFactory.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 SimpleYarnJobProxyFactory" class="title">Class SimpleYarnJobProxyFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.proxy.job.SimpleYarnJobProxyFactory</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/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job">JobProxyFactory</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleYarnJobProxyFactory</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job">JobProxyFactory</a></pre> +<div class="block">Factory to produce SimpleJobProxy instances. + + See <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-"><code>AbstractJobProxy.fromFactory(org.apache.samza.rest.resources.JobsResourceConfig)</code></a></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/SimpleYarnJobProxyFactory.html#SimpleYarnJobProxyFactory--">SimpleYarnJobProxyFactory</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><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/SimpleYarnJobProxyFactory.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> +<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> +</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="SimpleYarnJobProxyFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleYarnJobProxyFactory</h4> +<pre>public SimpleYarnJobProxyFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ 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>public <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html#getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">JobProxyFactory</a></code></span></div> +<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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html#getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">getJobProxy</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job">JobProxyFactory</a></code></dd> +<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/SimpleYarnJobProxy.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/YarnCliJobStatusProvider.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/SimpleYarnJobProxyFactory.html" target="_top">Frames</a></li> +<li><a href="SimpleYarnJobProxyFactory.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/latest/rest/javadocs/org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,348 @@ +<!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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>YarnCliJobStatusProvider (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="YarnCliJobStatusProvider (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div 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/SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html" target="_top">Frames</a></li> +<li><a href="YarnCliJobStatusProvider.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 YarnCliJobStatusProvider" class="title">Class YarnCliJobStatusProvider</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.proxy.job.YarnCliJobStatusProvider</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/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">YarnCliJobStatusProvider</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a></pre> +<div class="block">An implementation of the <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobStatusProvider</code></a> that retrieves + the job status from the YARN command line interface.</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/YarnCliJobStatusProvider.html#YarnCliJobStatusProvider-org.apache.samza.rest.script.ScriptPathProvider-">YarnCliJobStatusProvider</a></span>(<a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a> provider)</code> +<div class="block">Default 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="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><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/YarnCliJobStatusProvider.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/YarnCliJobStatusProvider.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> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html#getQualifiedJobName-org.apache.samza.rest.proxy.job.JobInstance-">getQualifiedJobName</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">Constructs the job name used in YARN.</div> +</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> +</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="YarnCliJobStatusProvider-org.apache.samza.rest.script.ScriptPathProvider-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>YarnCliJobStatusProvider</h4> +<pre>public YarnCliJobStatusProvider(<a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a> provider)</pre> +<div class="block">Default constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>provider</code> - a delegate that provides the path to the Samza yarn scripts.</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="getQualifiedJobName-org.apache.samza.rest.proxy.job.JobInstance-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifiedJobName</h4> +<pre>public static java.lang.String getQualifiedJobName(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance)</pre> +<div class="block">Constructs the job name used in YARN. This is the value shown in the "Name" + column of the Resource Manager UI.</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 job name to use for the job in YARN.</dd> +</dl> +</li> +</ul> +<a name="getJobStatuses-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobStatuses</h4> +<pre>public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatuses-java.util.Collection-">JobStatusProvider</a></code></span></div> +<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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatuses-java.util.Collection-">getJobStatuses</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a></code></dd> +<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>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/JobStatusProvider.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</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>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/SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html" target="_top">Frames</a></li> +<li><a href="YarnCliJobStatusProvider.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/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-frame.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-frame.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-frame.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-frame.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,31 @@ +<!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_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.proxy.job (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../../org/apache/samza/rest/proxy/job/package-summary.html" target="classFrame">org.apache.samza.rest.proxy.job</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="JobProxy.html" title="interface in org.apache.samza.rest.proxy.job" target="classFrame"><span class="interfaceName">JobProxy</span></a></li> +<li><a href="JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job" target="classFrame"><span class="interfaceName">JobProxyFactory</span></a></li> +<li><a href="JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job" target="classFrame"><span class="interfaceName">JobStatusProvider</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">AbstractJobProxy</a></li> +<li><a href="JobInstance.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">JobInstance</a></li> +<li><a href="ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">ScriptJobProxy</a></li> +<li><a href="SimpleYarnJobProxy.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">SimpleYarnJobProxy</a></li> +<li><a href="SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">SimpleYarnJobProxyFactory</a></li> +<li><a href="YarnCliJobStatusProvider.html" title="class in org.apache.samza.rest.proxy.job" target="classFrame">YarnCliJobStatusProvider</a></li> +</ul> +</div> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-summary.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-summary.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-summary.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-summary.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,204 @@ +<!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_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.proxy.job (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="org.apache.samza.rest.proxy.job (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>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/installation/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/samza/rest/resources/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.samza.rest.proxy.job</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job">JobProxy</a></td> +<td class="colLast"> +<div class="block">Job proxy is the primary abstraction used by the REST API to interact with jobs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job">JobProxyFactory</a></td> +<td class="colLast"> +<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.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a></td> +<td class="colLast"> +<div class="block">Interface for getting job status independent of the underlying cluster implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">AbstractJobProxy</a></td> +<td class="colLast"> +<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.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a></td> +<td class="colLast"> +<div class="block">Allows us to encapsulate the jobName,jobId tuple as one entity.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a></td> +<td class="colLast"> +<div class="block">Extends <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><code>AbstractJobProxy</code></a> with some script support functionality.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html" title="class in org.apache.samza.rest.proxy.job">SimpleYarnJobProxy</a></td> +<td class="colLast"> +<div class="block">Extends the <a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><code>ScriptJobProxy</code></a> with methods specific to simple Samza deployments.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job">SimpleYarnJobProxyFactory</a></td> +<td class="colLast"> +<div class="block">Factory to produce SimpleJobProxy instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html" title="class in org.apache.samza.rest.proxy.job">YarnCliJobStatusProvider</a></td> +<td class="colLast"> +<div class="block">An implementation of the <a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobStatusProvider</code></a> that retrieves + the job status from the YARN command line interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/installation/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/samza/rest/resources/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-tree.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-tree.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-tree.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/package-tree.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,152 @@ +<!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_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.proxy.job Class Hierarchy (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="org.apache.samza.rest.proxy.job Class Hierarchy (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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/installation/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/samza/rest/resources/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.samza.rest.proxy.job</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">AbstractJobProxy</span></a> (implements 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>) +<ul> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">ScriptJobProxy</span></a> (implements org.apache.samza.rest.script.<a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a>) +<ul> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">SimpleYarnJobProxy</span></a></li> +</ul> +</li> +</ul> +</li> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">JobInstance</span></a></li> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">SimpleYarnJobProxyFactory</span></a> (implements org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job">JobProxyFactory</a>)</li> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html" title="class in org.apache.samza.rest.proxy.job"><span class="typeNameLink">YarnCliJobStatusProvider</span></a> (implements org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job">JobStatusProvider</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">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"><span class="typeNameLink">JobProxy</span></a></li> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">JobProxyFactory</span></a></li> +<li type="circle">org.apache.samza.rest.proxy.job.<a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.html" title="interface in org.apache.samza.rest.proxy.job"><span class="typeNameLink">JobStatusProvider</span></a></li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/installation/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/samza/rest/resources/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/samza/rest/proxy/job/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/DefaultResourceFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/DefaultResourceFactory.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/DefaultResourceFactory.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/DefaultResourceFactory.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,287 @@ +<!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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>DefaultResourceFactory (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="DefaultResourceFactory (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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>Prev Class</li> +<li><a href="../../../../../org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/DefaultResourceFactory.html" target="_top">Frames</a></li> +<li><a href="DefaultResourceFactory.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.resources</div> +<h2 title="Class DefaultResourceFactory" class="title">Class DefaultResourceFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.resources.DefaultResourceFactory</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/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DefaultResourceFactory</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a></pre> +<div class="block">Instantiates all the resources that are shipped with the REST service.</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/resources/DefaultResourceFactory.html#DefaultResourceFactory--">DefaultResourceFactory</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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>java.util.List<? extends java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/DefaultResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">getResourceInstances</a></span>(org.apache.samza.config.Config config)</code> +<div class="block">Constructs and returns resource instances to register with the server.</div> +</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> +</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="DefaultResourceFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DefaultResourceFactory</h4> +<pre>public DefaultResourceFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getResourceInstances-org.apache.samza.config.Config-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getResourceInstances</h4> +<pre>public java.util.List<? extends java.lang.Object> getResourceInstances(org.apache.samza.config.Config config)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">ResourceFactory</a></code></span></div> +<div class="block">Constructs and returns resource instances to register with the server.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">getResourceInstances</a></code> in interface <code><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>config</code> - the server config used to initialize the objects.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a collection of instances to register with the server.</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/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/DefaultResourceFactory.html" target="_top">Frames</a></li> +<li><a href="DefaultResourceFactory.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/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResource.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResource.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResource.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResource.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,362 @@ +<!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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>JobsResource (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<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="JobsResource (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/JobsResource.html" target="_top">Frames</a></li> +<li><a href="JobsResource.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.resources</div> +<h2 title="Class JobsResource" class="title">Class JobsResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.resources.JobsResource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Singleton + @Path(value="/v1/jobs") +public class <span class="typeNameLabel">JobsResource</span> +extends java.lang.Object</pre> +<div class="block">The REST resource for jobs. Handles all requests for the jobs collection + or individual job instances.</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/resources/JobsResource.html#JobsResource-org.apache.samza.rest.resources.JobsResourceConfig-">JobsResource</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">Initializes a JobResource with <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> from the + <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class specified in the configuration.</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>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResource.html#getInstalledJobs--">getInstalledJobs</a></span>()</code> +<div class="block">Gets the <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for all the jobs installed on this host.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResource.html#getJob-java.lang.String-java.lang.String-">getJob</a></span>(java.lang.String jobName, + java.lang.String jobId)</code> +<div class="block">Gets the <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for the job instance specified by jobName and jobId if + it is installed on this host.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResource.html#updateJobStatus-java.lang.String-java.lang.String-java.lang.String-">updateJobStatus</a></span>(java.lang.String jobName, + java.lang.String jobId, + java.lang.String status)</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> +</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="JobsResource-org.apache.samza.rest.resources.JobsResourceConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JobsResource</h4> +<pre>public JobsResource(<a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</pre> +<div class="block">Initializes a JobResource with <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> from the + <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class specified in the configuration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>config</code> - the configuration containing the <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class.</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="getInstalledJobs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstalledJobs</h4> +<pre>@GET + @Produces(value="application/json") +public javax.ws.rs.core.Response getInstalledJobs()</pre> +<div class="block">Gets the <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for all the jobs installed on this host.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>Response.Status.OK</code> <code>Response</code> containing a list of + <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for all the installed Samza jobs installed on this host.</dd> +</dl> +</li> +</ul> +<a name="getJob-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJob</h4> +<pre>@GET + @Path(value="/{jobName}/{jobId}") + @Produces(value="application/json") +public javax.ws.rs.core.Response getJob(@PathParam(value="jobName") + java.lang.String jobName, + @PathParam(value="jobId") + java.lang.String jobId)</pre> +<div class="block">Gets the <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for the job instance specified by jobName and jobId if + it is installed on this host.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobName</code> - the name of the job as configured in <code>JobConfig.JOB_NAME()</code>.</dd> +<dd><code>jobId</code> - the id of the job as configured in <code>JobConfig.JOB_ID()</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>Response.Status.OK</code> <code>Response</code> + containing a <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for the Samza job if it is + installed on this host. <code>Response.Status.NOT_FOUND</code> and + <code>Response.Status.INTERNAL_SERVER_ERROR</code> can occur for corresponding errors.</dd> +</dl> +</li> +</ul> +<a name="updateJobStatus-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>updateJobStatus</h4> +<pre>@PUT + @Path(value="/{jobName}/{jobId}") + @Produces(value="application/json") +public javax.ws.rs.core.Response updateJobStatus(@PathParam(value="jobName") + java.lang.String jobName, + @PathParam(value="jobId") + java.lang.String jobId, + @QueryParam(value="status") + java.lang.String status)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobName</code> - the name of the job as configured in <code>JobConfig.JOB_NAME()</code>.</dd> +<dd><code>jobId</code> - the id of the job as configured in <code>JobConfig.JOB_ID()</code>.</dd> +<dd><code>status</code> - the <a href="../../../../../org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model"><code>JobStatus</code></a> to which the job will transition.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>Response.Status.ACCEPTED</code> <code>Response</code> + containing a <a href="../../../../../org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><code>Job</code></a> for the Samza job if it is + installed on this host. <code>Response.Status.NOT_FOUND</code> + <code>Response.Status.BAD_REQUEST</code> and + <code>Response.Status.INTERNAL_SERVER_ERROR</code> can occur for corresponding errors.</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/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/JobsResource.html" target="_top">Frames</a></li> +<li><a href="JobsResource.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>
