Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/CommandBuilder.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/CommandBuilder.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/CommandBuilder.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/CommandBuilder.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,398 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>CommandBuilder (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CommandBuilder (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/CommandBuilder.html" target="_top">Frames</a></li> +<li><a href="CommandBuilder.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.job</div> +<h2 title="Class CommandBuilder" class="title">Class CommandBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.job.CommandBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">CommandBuilder</span> +extends java.lang.Object</pre> +<div class="block">CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework, + such as YARN or the LocalJobRunner.</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="overviewSummary" 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/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#config">config</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#name">name</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.lang.Integer></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#taskNameToChangeLogPartitionMapping">taskNameToChangeLogPartitionMapping</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#taskNameToSystemStreamPartitionsMapping">taskNameToSystemStreamPartitionsMapping</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#CommandBuilder()">CommandBuilder</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#buildCommand()">buildCommand</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#buildEnvironment()">buildEnvironment</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#setConfig(org.apache.samza.config.Config)">setConfig</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#setTaskNameToChangeLogPartitionMapping(java.util.Map)">setTaskNameToChangeLogPartitionMapping</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.lang.Integer> mapping)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/CommandBuilder.html#setTaskNameToSystemStreamPartitionsMapping(java.util.Map)">setTaskNameToSystemStreamPartitionsMapping</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>>> systemStreamPartitionTaskNames)</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="taskNameToSystemStreamPartitionsMapping"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>taskNameToSystemStreamPartitionsMapping</h4> +<pre>protected java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>>> taskNameToSystemStreamPartitionsMapping</pre> +</li> +</ul> +<a name="taskNameToChangeLogPartitionMapping"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>taskNameToChangeLogPartitionMapping</h4> +<pre>protected java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.lang.Integer> taskNameToChangeLogPartitionMapping</pre> +</li> +</ul> +<a name="name"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>name</h4> +<pre>protected java.lang.String name</pre> +</li> +</ul> +<a name="config"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>config</h4> +<pre>protected <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CommandBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CommandBuilder</h4> +<pre>public CommandBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setTaskNameToSystemStreamPartitionsMapping(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTaskNameToSystemStreamPartitionsMapping</h4> +<pre>public <a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a> setTaskNameToSystemStreamPartitionsMapping(java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>>> systemStreamPartitionTaskNames)</pre> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public <a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a> setName(java.lang.String name)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - associated with a specific instantiation of a TaskRunner.</dd> +<dt><span class="strong">Returns:</span></dt><dd>self to support a builder style of use.</dd></dl> +</li> +</ul> +<a name="setConfig(org.apache.samza.config.Config)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfig</h4> +<pre>public <a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a> setConfig(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> +</li> +</ul> +<a name="setTaskNameToChangeLogPartitionMapping(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTaskNameToChangeLogPartitionMapping</h4> +<pre>public <a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a> setTaskNameToChangeLogPartitionMapping(java.util.Map<<a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a>,java.lang.Integer> mapping)</pre> +</li> +</ul> +<a name="buildCommand()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildCommand</h4> +<pre>public abstract java.lang.String buildCommand()</pre> +</li> +</ul> +<a name="buildEnvironment()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>buildEnvironment</h4> +<pre>public abstract java.util.Map<java.lang.String,java.lang.String> buildEnvironment()</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/CommandBuilder.html" target="_top">Frames</a></li> +<li><a href="CommandBuilder.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: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJob.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJob.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJob.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJob.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,284 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>StreamJob (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StreamJob (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/job/CommandBuilder.html" title="class in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/StreamJob.html" target="_top">Frames</a></li> +<li><a href="StreamJob.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.job</div> +<h2 title="Interface StreamJob" class="title">Interface StreamJob</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">StreamJob</span></pre> +<div class="block">A StreamJob runs Samza <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment. + Users generally do not need to implement a StreamJob themselves, rather it is a framework-level + interface meant for those extending Samza itself. This class, and its accompanying factory, + allow Samza to run on other service providers besides YARN and LocalJob, such as Mesos or Sun Grid Engine.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#getStatus()">getStatus</a></strong>()</code> +<div class="block">Get current <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#kill()">kill</a></strong>()</code> +<div class="block">Kill this job immediately.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#submit()">submit</a></strong>()</code> +<div class="block">Submit this job to be run.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForFinish(long)">waitForFinish</a></strong>(long timeoutMs)</code> +<div class="block">Block on this job until either it finishes or reaches its timeout value</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJob.html#waitForStatus(org.apache.samza.job.ApplicationStatus,%20long)">waitForStatus</a></strong>(<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> status, + long timeoutMs)</code> +<div class="block">Block on this job until either it transitions to the specified status or reaches it timeout value</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="submit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>submit</h4> +<pre><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a> submit()</pre> +<div class="block">Submit this job to be run.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An instance of this job after it has been submitted.</dd></dl> +</li> +</ul> +<a name="kill()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>kill</h4> +<pre><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a> kill()</pre> +<div class="block">Kill this job immediately.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An instance of this job after it has been killed.</dd></dl> +</li> +</ul> +<a name="waitForFinish(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitForFinish</h4> +<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> waitForFinish(long timeoutMs)</pre> +<div class="block">Block on this job until either it finishes or reaches its timeout value</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - How many milliseconds to wait before returning, assuming the job has not yet finished</dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job after finishing or timing out</dd></dl> +</li> +</ul> +<a name="waitForStatus(org.apache.samza.job.ApplicationStatus, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitForStatus</h4> +<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> waitForStatus(<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> status, + long timeoutMs)</pre> +<div class="block">Block on this job until either it transitions to the specified status or reaches it timeout value</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>status</code> - Target <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> to wait upon</dd><dd><code>timeoutMs</code> - How many milliseconds to wait before returning, assuming the job has not transitioned to the specified value</dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job after finishing or reaching target state</dd></dl> +</li> +</ul> +<a name="getStatus()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStatus</h4> +<pre><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a> getStatus()</pre> +<div class="block">Get current <a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><code>ApplicationStatus</code></a> of the job</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Current job status</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/job/CommandBuilder.html" title="class in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/StreamJob.html" target="_top">Frames</a></li> +<li><a href="StreamJob.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: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJobFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJobFactory.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJobFactory.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/StreamJobFactory.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,205 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>StreamJobFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StreamJobFactory (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/StreamJobFactory.html" target="_top">Frames</a></li> +<li><a href="StreamJobFactory.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.job</div> +<h2 title="Interface StreamJobFactory" class="title">Interface StreamJobFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">StreamJobFactory</span></pre> +<div class="block">Build a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/job/StreamJobFactory.html#getJob(org.apache.samza.config.Config)">getJob</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </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="getJob(org.apache.samza.config.Config)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getJob</h4> +<pre><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a> getJob(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/StreamJobFactory.html" target="_top">Frames</a></li> +<li><a href="StreamJobFactory.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: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-frame.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-frame.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-frame.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,28 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../org/apache/samza/job/package-summary.html" target="classFrame">org.apache.samza.job</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="StreamJob.html" title="interface in org.apache.samza.job" target="classFrame"><i>StreamJob</i></a></li> +<li><a href="StreamJobFactory.html" title="interface in org.apache.samza.job" target="classFrame"><i>StreamJobFactory</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="CommandBuilder.html" title="class in org.apache.samza.job" target="classFrame">CommandBuilder</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="ApplicationStatus.html" title="enum in org.apache.samza.job" target="classFrame">ApplicationStatus</a></li> +</ul> +</div> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-summary.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-summary.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-summary.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,174 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/container/grouper/stream/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/metrics/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.samza.job</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></td> +<td class="colLast"> +<div class="block">A StreamJob runs Samza <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s in its specific environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job">StreamJobFactory</a></td> +<td class="colLast"> +<div class="block">Build a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a></div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></td> +<td class="colLast"> +<div class="block">CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework, + such as YARN or the LocalJobRunner.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></td> +<td class="colLast"> +<div class="block">Status of a <a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><code>StreamJob</code></a> during and after its run.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/container/grouper/stream/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/metrics/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-tree.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-tree.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/job/package-tree.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,143 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>org.apache.samza.job Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.job Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/container/grouper/stream/package-tree.html">Prev</a></li> +<li><a href="../../../../org/apache/samza/metrics/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.samza.job</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.samza.job.<a href="../../../../org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job"><span class="strong">CommandBuilder</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.samza.job.<a href="../../../../org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><span class="strong">StreamJob</span></a></li> +<li type="circle">org.apache.samza.job.<a href="../../../../org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job"><span class="strong">StreamJobFactory</span></a></li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">org.apache.samza.job.<a href="../../../../org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/container/grouper/stream/package-tree.html">Prev</a></li> +<li><a href="../../../../org/apache/samza/metrics/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/job/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Counter.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Counter.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Counter.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Counter.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,386 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:18 PDT 2014 --> +<title>Counter (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Counter (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/metrics/Counter.html" target="_top">Frames</a></li> +<li><a href="Counter.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.metrics</div> +<h2 title="Class Counter" class="title">Class Counter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.metrics.Counter</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/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Counter</span> +extends java.lang.Object +implements <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></pre> +<div class="block">A counter is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that represents a cumulative value. + For example, the number of messages processed since the container was started.</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="overviewSummary" 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><strong><a href="../../../../org/apache/samza/metrics/Counter.html#Counter(java.lang.String)">Counter</a></strong>(java.lang.String name)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#dec()">dec</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#dec(long)">dec</a></strong>(long n)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#getCount()">getCount</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#inc()">inc</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#inc(long)">inc</a></strong>(long n)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#set(long)">set</a></strong>(long n)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Counter.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</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, 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="Counter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Counter</h4> +<pre>public Counter(java.lang.String name)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="inc()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>inc</h4> +<pre>public long inc()</pre> +</li> +</ul> +<a name="inc(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>inc</h4> +<pre>public long inc(long n)</pre> +</li> +</ul> +<a name="dec()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dec</h4> +<pre>public long dec()</pre> +</li> +</ul> +<a name="dec(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dec</h4> +<pre>public long dec(long n)</pre> +</li> +</ul> +<a name="set(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(long n)</pre> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +</li> +</ul> +<a name="getCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCount</h4> +<pre>public long getCount()</pre> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +</li> +</ul> +<a name="visit(org.apache.samza.metrics.MetricsVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public void visit(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/Metric.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/metrics/Counter.html" target="_top">Frames</a></li> +<li><a href="Counter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,350 @@ +<!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 (version 1.7.0_65) on Thu Aug 07 23:02:18 PDT 2014 --> +<title>Gauge (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Gauge (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/metrics/Gauge.html" target="_top">Frames</a></li> +<li><a href="Gauge.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.metrics</div> +<h2 title="Class Gauge" class="title">Class Gauge<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.metrics.Gauge<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Instance to be wrapped in the gauge for metering.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Gauge<T></span> +extends java.lang.Object +implements <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></pre> +<div class="block">A Gauge is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that wraps some instance of T in a thread-safe + reference and allows it to be set or retrieved. Gauages record specific values over time. + For example, the current length of a queue or the size of a buffer.</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="overviewSummary" 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><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#Gauge(java.lang.String,%20T)">Gauge</a></strong>(java.lang.String name, + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> value)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected, + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#getValue()">getValue</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</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, 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="Gauge(java.lang.String,java.lang.Object)"> +<!-- --> +</a><a name="Gauge(java.lang.String, T)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Gauge</h4> +<pre>public Gauge(java.lang.String name, + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> value)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="compareAndSet(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="compareAndSet(T, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareAndSet</h4> +<pre>public boolean compareAndSet(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected, + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</pre> +</li> +</ul> +<a name="set(java.lang.Object)"> +<!-- --> +</a><a name="set(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> set(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</pre> +</li> +</ul> +<a name="getValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValue</h4> +<pre>public <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> getValue()</pre> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +</li> +</ul> +<a name="visit(org.apache.samza.metrics.MetricsVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public void visit(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/Metric.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/metrics/Gauge.html" target="_top">Frames</a></li> +<li><a href="Gauge.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>
