Added: samza/site/learn/documentation/latest/rest/javadocs/index-all.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/index-all.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/index-all.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/index-all.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,660 @@ +<!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>Index (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="Index (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>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:Y">Y</a> <a name="I:A"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#AbstractJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">AbstractJobProxy(JobsResourceConfig)</a></span> - Constructor for 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></dt> +<dd> +<div class="block">Required constructor.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestService.html#addServlet-javax.servlet.Servlet-java.lang.String-">addServlet(Servlet, String)</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest">SamzaRestService</a></dt> +<dd> +<div class="block">Adds the specified <code>Servlet</code> to the server at the specified path.</div> +</dd> +</dl> +<a name="I:B"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#BIN_SUBPATH">BIN_SUBPATH</a></span> - Static variable in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +</dl> +<a name="I:C"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#CFG_SUBPATH">CFG_SUBPATH</a></span> - Static variable in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#config">config</a></span> - Variable in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_CONFIG_FACTORY">CONFIG_JOB_CONFIG_FACTORY</a></span> - Static variable in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> +<div class="block">Specifies the canonical name of the <code>ConfigFactory</code> to read the job configs.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_INSTALLATIONS_PATH">CONFIG_JOB_INSTALLATIONS_PATH</a></span> - Static variable in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> +<div class="block">The path where all the Samza jobs are installed (unzipped).</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_PROXY_FACTORY">CONFIG_JOB_PROXY_FACTORY</a></span> - Static variable in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> +<div class="block">Specifies the canonical name of 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 to produce + <a href="org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> instances.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#CONFIG_MONITOR_CLASSES">CONFIG_MONITOR_CLASSES</a></span> - Static variable in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> +<div class="block">Specifies a comma-delimited list of class names corresponding to Monitor implementations.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#CONFIG_MONITOR_INTERVAL_MS">CONFIG_MONITOR_INTERVAL_MS</a></span> - Static variable in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> +<div class="block">Specifies the interval at which each registered Monitor's monitor method will be called.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#CONFIG_REST_RESOURCE_CLASSES">CONFIG_REST_RESOURCE_CLASSES</a></span> - Static variable in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> +<div class="block">Specifies a comma-delimited list of class names of resources to register with the server.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#CONFIG_REST_RESOURCE_FACTORIES">CONFIG_REST_RESOURCE_FACTORIES</a></span> - Static variable in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> +<div class="block">Specifies a comma-delimited list of class names that implement ResourceFactory.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#CONFIG_SAMZA_REST_SERVICE_PORT">CONFIG_SAMZA_REST_SERVICE_PORT</a></span> - Static variable in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> +<div class="block">The port number to use for the HTTP server or 0 to dynamically choose a port.</div> +</dd> +</dl> +<a name="I:D"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><a href="org/apache/samza/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">DefaultResourceFactory</span></a> - Class in <a href="org/apache/samza/rest/resources/package-summary.html">org.apache.samza.rest.resources</a></dt> +<dd> +<div class="block">Instantiates all the resources that are shipped with the REST service.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/DefaultResourceFactory.html#DefaultResourceFactory--">DefaultResourceFactory()</a></span> - Constructor for class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources">DefaultResourceFactory</a></dt> +<dd> </dd> +</dl> +<a name="I:E"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class 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">JobInstance</a></dt> +<dd> </dd> +</dl> +<a name="I:F"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#fromFactory-org.apache.samza.rest.resources.JobsResourceConfig-">fromFactory(JobsResourceConfig)</a></span> - Static method in 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></dt> +<dd> +<div class="block">Creates a new JobProxy instance from the factory class specified in the config.</div> +</dd> +</dl> +<a name="I:G"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html#getAllInstalledJobs--">getAllInstalledJobs()</a></span> - Method in interface org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#getAllInstalledJobs--">getAllInstalledJobs()</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobInstances--">getAllJobInstances()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#getAllJobInstances--">getAllJobInstances()</a></span> - Method in class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getAllJobStatuses--">getAllJobStatuses()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxy.html#getAllJobStatuses--">getAllJobStatuses()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html#getConfigFilePath--">getConfigFilePath()</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#getConfigMonitorClassList--">getConfigMonitorClassList()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#getConfigMonitorIntervalMs--">getConfigMonitorIntervalMs()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/ScriptJobProxy.html#getInstallationFinder--">getInstallationFinder()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#getInstallationFinder--">getInstallationFinder()</a></span> - Method in class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#getInstallationsPath--">getInstallationsPath()</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResource.html#getInstalledJobs--">getInstalledJobs()</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources">JobsResource</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResource.html#getJob-java.lang.String-java.lang.String-">getJob(String, String)</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources">JobsResource</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobConfigFactory--">getJobConfigFactory()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#getJobId--">getJobId()</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#getJobId--">getJobId()</a></span> - Method in class 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">JobInstance</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#getJobName--">getJobName()</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#getJobName--">getJobName()</a></span> - Method in class 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">JobInstance</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxyFactory.html#getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">getJobProxy(JobsResourceConfig)</a></span> - Method in interface 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></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html#getJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">getJobProxy(JobsResourceConfig)</a></span> - Method in class 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">SimpleYarnJobProxyFactory</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#getJobProxyFactory--">getJobProxyFactory()</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobSamzaStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobSamzaStatus(JobInstance)</a></span> - Method in 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></dt> +<dd> +<div class="block">Convenience method to get the Samza job status from the name and id.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus(JobInstance)</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxy.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus(JobInstance)</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus(JobInstance)</a></span> - Method in interface 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html#getJobStatus-org.apache.samza.rest.proxy.job.JobInstance-">getJobStatus(JobInstance)</a></span> - Method in class 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">YarnCliJobStatusProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobStatusProvider.html#getJobStatuses-java.util.Collection-">getJobStatuses(Collection<Job>)</a></span> - Method in interface 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></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html#getJobStatuses-java.util.Collection-">getJobStatuses(Collection<Job>)</a></span> - Method in class 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">YarnCliJobStatusProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#getJobStatusProvider--">getJobStatusProvider()</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#getJobStatusProvider--">getJobStatusProvider()</a></span> - Method in class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#getPort--">getPort()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html#getQualifiedJobName-org.apache.samza.rest.proxy.job.JobInstance-">getQualifiedJobName(JobInstance)</a></span> - Static method in class 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">YarnCliJobStatusProvider</a></dt> +<dd> +<div class="block">Constructs the job name used in YARN.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#getResourceClassNames--">getResourceClassNames()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#getResourceFactoryClassNames--">getResourceFactoryClassNames()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/DefaultResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">getResourceInstances(Config)</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources">DefaultResourceFactory</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/ResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">getResourceInstances(Config)</a></span> - Method in interface org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a></dt> +<dd> +<div class="block">Constructs and returns resource instances to register with the server.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html#getRootPath--">getRootPath()</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html#getScriptFilePath--">getScriptFilePath()</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dt> +<dd> </dd> +<dt><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(JobInstance, String)</a></span> - Method in 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></dt> +<dd> +<div class="block">Constructs the path to the specified script within the job installation.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptPathProvider.html#getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-">getScriptPath(JobInstance, String)</a></span> - Method in interface org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptRunner.html#getScriptTimeoutS--">getScriptTimeoutS()</a></span> - Method in class org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#getStatus--">getStatus()</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#getStatusDetail--">getStatusDetail()</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +</dl> +<a name="I:H"> +<!-- --> +</a> +<h2 class="title">H</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/JobStatus.html#hasBeenStarted--">hasBeenStarted()</a></span> - Method in enum org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#hashCode--">hashCode()</a></span> - Method in class 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">JobInstance</a></dt> +<dd> </dd> +</dl> +<a name="I:I"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation"><span class="typeNameLink">InstallationFinder</span></a> - Interface in <a href="org/apache/samza/rest/proxy/installation/package-summary.html">org.apache.samza.rest.proxy.installation</a></dt> +<dd> +<div class="block">Finds all the installed jobs.</div> +</dd> +<dt><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation"><span class="typeNameLink">InstallationRecord</span></a> - Class in <a href="org/apache/samza/rest/proxy/installation/package-summary.html">org.apache.samza.rest.proxy.installation</a></dt> +<dd> +<div class="block">Represents an installation of one Samza job instance on a file system.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html#InstallationRecord-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">InstallationRecord(String, String, String, String, String)</a></span> - Constructor for class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#installationsPath">installationsPath</a></span> - Variable in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html#isInstalled-org.apache.samza.rest.proxy.job.JobInstance-">isInstalled(JobInstance)</a></span> - Method in interface org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation">InstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#isInstalled-org.apache.samza.rest.proxy.job.JobInstance-">isInstalled(JobInstance)</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +</dl> +<a name="I:J"> +<!-- --> +</a> +<h2 class="title">J</h2> +<dl> +<dt><a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model"><span class="typeNameLink">Job</span></a> - Class in <a href="org/apache/samza/rest/model/package-summary.html">org.apache.samza.rest.model</a></dt> +<dd> +<div class="block">The client view of a job.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#Job-java.lang.String-java.lang.String-">Job(String, String)</a></span> - Constructor for class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#Job-java.lang.String-java.lang.String-org.apache.samza.rest.model.JobStatus-java.lang.String-">Job(String, String, JobStatus, String)</a></span> - Constructor for class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#Job--">Job()</a></span> - Constructor for class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#jobConfigFactory">jobConfigFactory</a></span> - Variable in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/AbstractJobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists(JobInstance)</a></span> - Method in 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></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxy.html#jobExists-org.apache.samza.rest.proxy.job.JobInstance-">jobExists(JobInstance)</a></span> - Method in 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></dt> +<dd> </dd> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<div class="block">Allows us to encapsulate the jobName,jobId tuple as one entity.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#JobInstance-java.lang.String-java.lang.String-">JobInstance(String, String)</a></span> - Constructor for class 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">JobInstance</a></dt> +<dd> +<div class="block">Required constructor.</div> +</dd> +<dt><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> - Interface in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<div class="block">Job proxy is the primary abstraction used by the REST API to interact with jobs.</div> +</dd> +<dt><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> - Interface in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<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> +</dd> +<dt><a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">JobsResource</span></a> - Class in <a href="org/apache/samza/rest/resources/package-summary.html">org.apache.samza.rest.resources</a></dt> +<dd> +<div class="block">The REST resource for jobs.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResource.html#JobsResource-org.apache.samza.rest.resources.JobsResourceConfig-">JobsResource(JobsResourceConfig)</a></span> - Constructor for class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources">JobsResource</a></dt> +<dd> +<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> +</dd> +<dt><a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">JobsResourceConfig</span></a> - Class in <a href="org/apache/samza/rest/resources/package-summary.html">org.apache.samza.rest.resources</a></dt> +<dd> +<div class="block">Configurations for the <a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><code>JobsResource</code></a> endpoint.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResourceConfig.html#JobsResourceConfig-org.apache.samza.config.Config-">JobsResourceConfig(Config)</a></span> - Constructor for class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model"><span class="typeNameLink">JobStatus</span></a> - Enum in <a href="org/apache/samza/rest/model/package-summary.html">org.apache.samza.rest.model</a></dt> +<dd> +<div class="block">The abstract status of the job, irrespective of the status in any underlying cluster management system (e.g.</div> +</dd> +<dt><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> - Interface in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<div class="block">Interface for getting job status independent of the underlying cluster implementation.</div> +</dd> +</dl> +<a name="I:M"> +<!-- --> +</a> +<h2 class="title">M</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestService.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest">SamzaRestService</a></dt> +<dd> +<div class="block">Command line interface to run the server.</div> +</dd> +<dt><a href="org/apache/samza/monitor/Monitor.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Monitor</span></a> - Interface in <a href="org/apache/samza/monitor/package-summary.html">org.apache.samza.monitor</a></dt> +<dd> +<div class="block">A Monitor is a class implementing some functionality that should be done every N milliseconds on a YARN RM or NM.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/Monitor.html#monitor--">monitor()</a></span> - Method in interface org.apache.samza.monitor.<a href="org/apache/samza/monitor/Monitor.html" title="interface in org.apache.samza.monitor">Monitor</a></dt> +<dd> +<div class="block">Do the work of the monitor.</div> +</dd> +</dl> +<a name="I:O"> +<!-- --> +</a> +<h2 class="title">O</h2> +<dl> +<dt><a href="org/apache/samza/monitor/package-summary.html">org.apache.samza.monitor</a> - package org.apache.samza.monitor</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/package-summary.html">org.apache.samza.rest</a> - package org.apache.samza.rest</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/model/package-summary.html">org.apache.samza.rest.model</a> - package org.apache.samza.rest.model</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/proxy/installation/package-summary.html">org.apache.samza.rest.proxy.installation</a> - package org.apache.samza.rest.proxy.installation</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a> - package org.apache.samza.rest.proxy.job</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/resources/package-summary.html">org.apache.samza.rest.resources</a> - package org.apache.samza.rest.resources</dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/script/package-summary.html">org.apache.samza.rest.script</a> - package org.apache.samza.rest.script</dt> +<dd> </dd> +</dl> +<a name="I:P"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptOutputHandler.html#processScriptOutput-java.io.InputStream-">processScriptOutput(InputStream)</a></span> - Method in interface org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script">ScriptOutputHandler</a></dt> +<dd> +<div class="block">Processes the script output represented by the InputStream.</div> +</dd> +</dl> +<a name="I:R"> +<!-- --> +</a> +<h2 class="title">R</h2> +<dl> +<dt><a href="org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources"><span class="typeNameLink">ResourceFactory</span></a> - Interface in <a href="org/apache/samza/rest/resources/package-summary.html">org.apache.samza.rest.resources</a></dt> +<dd> +<div class="block">Instantiates a resource using the provided config.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptRunner.html#runScript-java.lang.String-java.lang.String...-">runScript(String, String...)</a></span> - Method in class org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></dt> +<dd> +<div class="block">Runs a script with IO inherited from the current Java process.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptRunner.html#runScript-java.lang.String-org.apache.samza.rest.script.ScriptOutputHandler-java.lang.String...-">runScript(String, ScriptOutputHandler, String...)</a></span> - Method in class org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></dt> +<dd> </dd> +</dl> +<a name="I:S"> +<!-- --> +</a> +<h2 class="title">S</h2> +<dl> +<dt><a href="org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">SamzaMonitorService</span></a> - Class in <a href="org/apache/samza/monitor/package-summary.html">org.apache.samza.monitor</a></dt> +<dd> +<div class="block">The class responsible for handling long-running/scheduled monitors in Samza REST.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/SamzaMonitorService.html#SamzaMonitorService-org.apache.samza.rest.SamzaRestConfig-org.apache.samza.monitor.SchedulingProvider-">SamzaMonitorService(SamzaRestConfig, SchedulingProvider)</a></span> - Constructor for class org.apache.samza.monitor.<a href="org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor">SamzaMonitorService</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/SamzaRestApplication.html" title="class in org.apache.samza.rest"><span class="typeNameLink">SamzaRestApplication</span></a> - Class in <a href="org/apache/samza/rest/package-summary.html">org.apache.samza.rest</a></dt> +<dd> +<div class="block">Samza REST implementation of the JAX-RS <code>Application</code> model.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestApplication.html#SamzaRestApplication-org.apache.samza.rest.SamzaRestConfig-">SamzaRestApplication(SamzaRestConfig)</a></span> - Constructor for class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestApplication.html" title="class in org.apache.samza.rest">SamzaRestApplication</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest"><span class="typeNameLink">SamzaRestConfig</span></a> - Class in <a href="org/apache/samza/rest/package-summary.html">org.apache.samza.rest</a></dt> +<dd> +<div class="block">The set of configurations required by the core components of the <a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest"><code>SamzaRestService</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestConfig.html#SamzaRestConfig-org.apache.samza.config.Config-">SamzaRestConfig(Config)</a></span> - Constructor for class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest"><span class="typeNameLink">SamzaRestService</span></a> - Class in <a href="org/apache/samza/rest/package-summary.html">org.apache.samza.rest</a></dt> +<dd> +<div class="block">The main Java class for the Samza REST API.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestService.html#SamzaRestService-org.apache.samza.rest.SamzaRestConfig-">SamzaRestService(SamzaRestConfig)</a></span> - Constructor for class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest">SamzaRestService</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html#schedule-java.lang.Runnable-int-">schedule(Runnable, int)</a></span> - Method in class org.apache.samza.monitor.<a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor">ScheduledExecutorSchedulingProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/SchedulingProvider.html#schedule-java.lang.Runnable-int-">schedule(Runnable, int)</a></span> - Method in interface org.apache.samza.monitor.<a href="org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">ScheduledExecutorSchedulingProvider</span></a> - Class in <a href="org/apache/samza/monitor/package-summary.html">org.apache.samza.monitor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html#ScheduledExecutorSchedulingProvider-java.util.concurrent.ScheduledExecutorService-">ScheduledExecutorSchedulingProvider(ScheduledExecutorService)</a></span> - Constructor for class org.apache.samza.monitor.<a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor">ScheduledExecutorSchedulingProvider</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">SchedulingProvider</span></a> - Interface in <a href="org/apache/samza/monitor/package-summary.html">org.apache.samza.monitor</a></dt> +<dd> +<div class="block">Provides scheduling functionality to the SamzaMonitorService.</div> +</dd> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/ScriptJobProxy.html#ScriptJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">ScriptJobProxy(JobsResourceConfig)</a></span> - Constructor for 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></dt> +<dd> +<div class="block">Required constructor.</div> +</dd> +<dt><a href="org/apache/samza/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">ScriptOutputHandler</span></a> - Interface in <a href="org/apache/samza/rest/script/package-summary.html">org.apache.samza.rest.script</a></dt> +<dd> +<div class="block">A script output handler processes the stream of output from the stdout and stderr channels of a script.</div> +</dd> +<dt><a href="org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">ScriptPathProvider</span></a> - Interface in <a href="org/apache/samza/rest/script/package-summary.html">org.apache.samza.rest.script</a></dt> +<dd> +<div class="block">Defines the protocol for getting script paths.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/ScriptJobProxy.html#scriptRunner">scriptRunner</a></span> - Variable in 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></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script"><span class="typeNameLink">ScriptRunner</span></a> - Class in <a href="org/apache/samza/rest/script/package-summary.html">org.apache.samza.rest.script</a></dt> +<dd> +<div class="block">Runs a script process and returns the exit code.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/script/ScriptRunner.html#ScriptRunner--">ScriptRunner()</a></span> - Constructor for class org.apache.samza.rest.script.<a href="org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#setJobId-java.lang.String-">setJobId(String)</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#setJobName-java.lang.String-">setJobName(String)</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#setStatus-org.apache.samza.rest.model.JobStatus-">setStatus(JobStatus)</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/Job.html#setStatusDetail-java.lang.String-">setStatusDetail(String)</a></span> - Method in class org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/Job.html" title="class in org.apache.samza.rest.model">Job</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation"><span class="typeNameLink">SimpleInstallationFinder</span></a> - Class in <a href="org/apache/samza/rest/proxy/installation/package-summary.html">org.apache.samza.rest.proxy.installation</a></dt> +<dd> +<div class="block">A simple default implementation of <a href="org/apache/samza/rest/proxy/installation/InstallationFinder.html" title="interface in org.apache.samza.rest.proxy.installation"><code>InstallationFinder</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html#SimpleInstallationFinder-java.lang.String-org.apache.samza.config.ConfigFactory-">SimpleInstallationFinder(String, ConfigFactory)</a></span> - Constructor for class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/SimpleInstallationFinder.html" title="class in org.apache.samza.rest.proxy.installation">SimpleInstallationFinder</a></dt> +<dd> +<div class="block">Required constructor.</div> +</dd> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#SimpleYarnJobProxy-org.apache.samza.rest.resources.JobsResourceConfig-">SimpleYarnJobProxy(JobsResourceConfig)</a></span> - Constructor for class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<div class="block">Factory to produce SimpleJobProxy instances.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxyFactory.html#SimpleYarnJobProxyFactory--">SimpleYarnJobProxyFactory()</a></span> - Constructor for class 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">SimpleYarnJobProxyFactory</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/SamzaMonitorService.html#start--">start()</a></span> - Method in class org.apache.samza.monitor.<a href="org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor">SamzaMonitorService</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxy.html#start-org.apache.samza.rest.proxy.job.JobInstance-">start(JobInstance)</a></span> - Method in 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></dt> +<dd> +<div class="block">Starts the job instance specified by jobName and jobId.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#start-org.apache.samza.rest.proxy.job.JobInstance-">start(JobInstance)</a></span> - Method in class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestService.html#start--">start()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest">SamzaRestService</a></dt> +<dd> +<div class="block">Starts the server asynchronously.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/SamzaMonitorService.html#stop--">stop()</a></span> - Method in class org.apache.samza.monitor.<a href="org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor">SamzaMonitorService</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html#stop--">stop()</a></span> - Method in class org.apache.samza.monitor.<a href="org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor">ScheduledExecutorSchedulingProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/monitor/SchedulingProvider.html#stop--">stop()</a></span> - Method in interface org.apache.samza.monitor.<a href="org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobProxy.html#stop-org.apache.samza.rest.proxy.job.JobInstance-">stop(JobInstance)</a></span> - Method in 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></dt> +<dd> +<div class="block">Stops the job instance specified by jobName and jobId.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html#stop-org.apache.samza.rest.proxy.job.JobInstance-">stop(JobInstance)</a></span> - Method in class 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">SimpleYarnJobProxy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/SamzaRestService.html#stop--">stop()</a></span> - Method in class org.apache.samza.rest.<a href="org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest">SamzaRestService</a></dt> +<dd> +<div class="block">Stops the server.</div> +</dd> +</dl> +<a name="I:T"> +<!-- --> +</a> +<h2 class="title">T</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/JobStatus.html#toString--">toString()</a></span> - Method in enum org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html#toString--">toString()</a></span> - Method in class org.apache.samza.rest.proxy.installation.<a href="org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation">InstallationRecord</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/JobInstance.html#toString--">toString()</a></span> - Method in class 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">JobInstance</a></dt> +<dd> </dd> +</dl> +<a name="I:U"> +<!-- --> +</a> +<h2 class="title">U</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/resources/JobsResource.html#updateJobStatus-java.lang.String-java.lang.String-java.lang.String-">updateJobStatus(String, String, String)</a></span> - Method in class org.apache.samza.rest.resources.<a href="org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources">JobsResource</a></dt> +<dd> </dd> +</dl> +<a name="I:V"> +<!-- --> +</a> +<h2 class="title">V</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/JobStatus.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/model/JobStatus.html#values--">values()</a></span> - Static method in enum org.apache.samza.rest.model.<a href="org/apache/samza/rest/model/JobStatus.html" title="enum in org.apache.samza.rest.model">JobStatus</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +</dl> +<a name="I:Y"> +<!-- --> +</a> +<h2 class="title">Y</h2> +<dl> +<dt><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> - Class in <a href="org/apache/samza/rest/proxy/job/package-summary.html">org.apache.samza.rest.proxy.job</a></dt> +<dd> +<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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/rest/proxy/job/YarnCliJobStatusProvider.html#YarnCliJobStatusProvider-org.apache.samza.rest.script.ScriptPathProvider-">YarnCliJobStatusProvider(ScriptPathProvider)</a></span> - Constructor for class 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">YarnCliJobStatusProvider</a></dt> +<dd> +<div class="block">Default constructor.</div> +</dd> +</dl> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:Y">Y</a> </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>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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/index.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/index.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/index.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/index.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>samza-rest 0.10.1-SNAPSHOT API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/Monitor.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/Monitor.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/Monitor.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/Monitor.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,234 @@ +<!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>Monitor (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="Monitor (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>Prev Class</li> +<li><a href="../../../../org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/Monitor.html" target="_top">Frames</a></li> +<li><a href="Monitor.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.monitor</div> +<h2 title="Interface Monitor" class="title">Interface Monitor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Monitor</span></pre> +<div class="block">A Monitor is a class implementing some functionality that should be done every N milliseconds on a YARN RM or NM. + Classes specified in the config will have their monitor() method called at a configurable interval. + For example, one could implement a Monitor that checks for leaked containers and kills them, ensuring that + no leaked container survives on a NodeManager host for more than N ms (where N is the monitor run interval.) + + Implementations can override .toString() for better logging.</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/monitor/Monitor.html#monitor--">monitor</a></span>()</code> +<div class="block">Do the work of the monitor.</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="monitor--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>monitor</h4> +<pre>void monitor() + throws java.lang.Exception</pre> +<div class="block">Do the work of the monitor. Because this can be arbitrary behavior up to and including script execution, + IPC-related IOExceptions and concurrency-related InterruptedExceptions are caught by the SamzaMonitorService.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if there was any problem running the monitor.</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/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/Monitor.html" target="_top">Frames</a></li> +<li><a href="Monitor.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/monitor/SamzaMonitorService.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SamzaMonitorService.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SamzaMonitorService.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SamzaMonitorService.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>SamzaMonitorService (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="SamzaMonitorService (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":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/monitor/Monitor.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/SamzaMonitorService.html" target="_top">Frames</a></li> +<li><a href="SamzaMonitorService.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.monitor</div> +<h2 title="Class SamzaMonitorService" class="title">Class SamzaMonitorService</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.monitor.SamzaMonitorService</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SamzaMonitorService</span> +extends java.lang.Object</pre> +<div class="block">The class responsible for handling long-running/scheduled monitors in Samza REST. + Takes a SamzaRestConfig object in the constructor and handles instantiation of + monitors and scheduling them to run based on the properties in the config.</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/monitor/SamzaMonitorService.html#SamzaMonitorService-org.apache.samza.rest.SamzaRestConfig-org.apache.samza.monitor.SchedulingProvider-">SamzaMonitorService</a></span>(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> config, + <a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a> schedulingProvider)</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/monitor/SamzaMonitorService.html#start--">start</a></span>()</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/monitor/SamzaMonitorService.html#stop--">stop</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, 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="SamzaMonitorService-org.apache.samza.rest.SamzaRestConfig-org.apache.samza.monitor.SchedulingProvider-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SamzaMonitorService</h4> +<pre>public SamzaMonitorService(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> config, + <a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a> schedulingProvider)</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--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start()</pre> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop()</pre> +</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/monitor/Monitor.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/SamzaMonitorService.html" target="_top">Frames</a></li> +<li><a href="SamzaMonitorService.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>
