Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxy.html Tue Aug 23 17:38:58 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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>JobProxy (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="JobProxy (samza-rest 0.10.1-SNAPSHOT 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/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobProxyFactory.html Tue Aug 23 17:38:58 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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>JobProxyFactory (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="JobProxyFactory (samza-rest 0.10.1-SNAPSHOT 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/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/JobStatusProvider.html Tue Aug 23 17:38:58 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_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>JobStatusProvider (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="JobStatusProvider (samza-rest 0.10.1-SNAPSHOT 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> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/ScriptJobProxy.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/ScriptJobProxy.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/ScriptJobProxy.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/ScriptJobProxy.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,382 @@ +<!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>ScriptJobProxy (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="ScriptJobProxy (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":10}; +var tabs = {65535:["t0","All 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><a href="../../../../../../org/apache/samza/rest/proxy/job/JobStatusProvider.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/SimpleYarnJobProxy.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/ScriptJobProxy.html" target="_top">Frames</a></li> +<li><a href="ScriptJobProxy.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 ScriptJobProxy" class="title">Class ScriptJobProxy</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">org.apache.samza.rest.proxy.job.AbstractJobProxy</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.proxy.job.ScriptJobProxy</li> +</ul> +</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>, <a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><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 abstract class <span class="typeNameLabel">ScriptJobProxy</span> +extends <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">AbstractJobProxy</a> +implements <a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></pre> +<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> +</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/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html#scriptRunner">scriptRunner</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.samza.rest.proxy.job.AbstractJobProxy"> +<!-- --> +</a> +<h3>Fields inherited from class 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">AbstractJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#config">config</a></code></li> +</ul> +</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/ScriptJobProxy.html#ScriptJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">ScriptJobProxy</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="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>protected abstract <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html#getInstallationFinder--">getInstallationFinder</a></span>()</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/ScriptJobProxy.html#getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-">getScriptPath</a></span>(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance, + java.lang.String scriptName)</code> +<div class="block">Constructs the path to the specified script within the job installation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.rest.proxy.job.AbstractJobProxy"> +<!-- --> +</a> +<h3>Methods inherited from class 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">AbstractJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-">fromFactory</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobInstances--">getAllJobInstances</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobStatuses--">getAllJobStatuses</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobConfigFactory--">getJobConfigFactory</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobSamzaStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobSamzaStatus</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatusProvider--">getJobStatusProv ider</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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="scriptRunner"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>scriptRunner</h4> +<pre>protected final <a href="../../../../../../org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a> scriptRunner</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ScriptJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ScriptJobProxy</h4> +<pre>public ScriptJobProxy(<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 which specifies the path to the Samza framework installation.</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="getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScriptPath</h4> +<pre>public java.lang.String getScriptPath(<a href="../../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance, + java.lang.String scriptName) + throws java.io.FileNotFoundException</pre> +<div class="block">Constructs the path to the specified script within the job installation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html#getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-">getScriptPath</a></code> in interface <code><a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobInstance</code> - the instance of the job.</dd> +<dd><code>scriptName</code> - the name of the script.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the full path to the script.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.FileNotFoundException</code> - if the job installation path doesn't exist.</dd> +</dl> +</li> +</ul> +<a name="getInstallationFinder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInstallationFinder</h4> +<pre>protected abstract <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a> getInstallationFinder()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation"><code>InstallationFinder</code></a> which will be used to find jobs installed on this machine.</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/JobStatusProvider.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/SimpleYarnJobProxy.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/ScriptJobProxy.html" target="_top">Frames</a></li> +<li><a href="ScriptJobProxy.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/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,415 @@ +<!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>SimpleYarnJobProxy (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="SimpleYarnJobProxy (samza-rest 0.10.1-SNAPSHOT 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/ScriptJobProxy.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/SimpleYarnJobProxyFactory.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/SimpleYarnJobProxy.html" target="_top">Frames</a></li> +<li><a href="SimpleYarnJobProxy.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="#fields.inherited.from.class.org.apache.samza.rest.proxy.job.ScriptJobProxy">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>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 SimpleYarnJobProxy" class="title">Class SimpleYarnJobProxy</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">org.apache.samza.rest.proxy.job.AbstractJobProxy</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">org.apache.samza.rest.proxy.job.ScriptJobProxy</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.proxy.job.SimpleYarnJobProxy</li> +</ul> +</li> +</ul> +</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>, <a href="../../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleYarnJobProxy</span> +extends <a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a></pre> +<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> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.samza.rest.proxy.job.ScriptJobProxy"> +<!-- --> +</a> +<h3>Fields inherited from class 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">ScriptJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html#scriptRunner">scriptRunner</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.samza.rest.proxy.job.AbstractJobProxy"> +<!-- --> +</a> +<h3>Fields inherited from class 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">AbstractJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#config">config</a></code></li> +</ul> +</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/SimpleYarnJobProxy.html#SimpleYarnJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">SimpleYarnJobProxy</a></span>(<a href="../../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a> config)</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>protected 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/SimpleYarnJobProxy.html#getAllJobInstances--">getAllJobInstances</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#getInstallationFinder--">getInstallationFinder</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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/SimpleYarnJobProxy.html#getJobStatusProvider--">getJobStatusProvider</a></span>()</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/SimpleYarnJobProxy.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/SimpleYarnJobProxy.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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.rest.proxy.job.ScriptJobProxy"> +<!-- --> +</a> +<h3>Methods inherited from class 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">ScriptJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html#getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-">getScriptPath</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.rest.proxy.job.AbstractJobProxy"> +<!-- --> +</a> +<h3>Methods inherited from class 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">AbstractJobProxy</a></h3> +<code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-">fromFactory</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobStatuses--">getAllJobStatuses</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobConfigFactory--">getJobConfigFactory</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobSamzaStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobSamzaStatus</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus</a>, <a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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="SimpleYarnJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleYarnJobProxy</h4> +<pre>public SimpleYarnJobProxy(<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> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="start-org.apache.samza.rest.proxy.job.JobInstance-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#start-org.apache.samza.rest.proxy.job.JobInstance-">JobProxy</a></code></span></div> +<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="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/samza/rest/proxy/job/JobProxy.html#stop-org.apache.samza.rest.proxy.job.JobInstance-">JobProxy</a></code></span></div> +<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> +<a name="getJobStatusProvider--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobStatusProvider</h4> +<pre>public <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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatusProvider--">getJobStatusProvider</a></code> in class <code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">AbstractJobProxy</a></code></dd> +<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 for retrieving job status.</dd> +</dl> +</li> +</ul> +<a name="getAllJobInstances--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllJobInstances</h4> +<pre>protected 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobInstances--">getAllJobInstances</a></code> in class <code><a href="../../../../../../org/apache/samza/rest/proxy/job/AbstractJobProxy.html" title="class in org.apache.samza.rest.proxy.job">AbstractJobProxy</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>all available job instances.</dd> +</dl> +</li> +</ul> +<a name="getInstallationFinder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInstallationFinder</h4> +<pre>protected <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a> getInstallationFinder()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html#getInstallationFinder--">getInstallationFinder</a></code> in class <code><a href="../../../../../../org/apache/samza/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../../org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation"><code>InstallationFinder</code></a> which will be used to find jobs installed on this machine.</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/ScriptJobProxy.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/SimpleYarnJobProxyFactory.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/SimpleYarnJobProxy.html" target="_top">Frames</a></li> +<li><a href="SimpleYarnJobProxy.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="#fields.inherited.from.class.org.apache.samza.rest.proxy.job.ScriptJobProxy">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>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>
