http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/index-all.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/index-all.html b/docs/learn/documentation/versioned/api/javadocs/index-all.html new file mode 100644 index 0000000..9d364b3 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/index-all.html @@ -0,0 +1,1386 @@ +<!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 Tue Aug 05 21:46:34 PDT 2014 --> +<title>Index (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="Index (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>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="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_K_">K</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#afterClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterClose(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called after all tasks in TaskRunner are closed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#afterInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterInit(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called after all tasks in TaskRunner are initialized.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#afterProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterProcess(IncomingMessageEnvelope, Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called after a message is processed by a task.</div> +</dd> +<dt><a href="./org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</span></a> - Enum in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt> +<dd> +<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> +</dd> +</dl> +<a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><a href="./org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="strong">BaseMessageChooser</span></a> - Class in <a href="./org/apache/samza/system/chooser/package-summary.html">org.apache.samza.system.chooser</a></dt> +<dd> +<div class="block">An abstract MessageChooser that implements start/stop/register for choosers + that don't use them.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/chooser/BaseMessageChooser.html#BaseMessageChooser()">BaseMessageChooser()</a></span> - Constructor for class org.apache.samza.system.chooser.<a href="./org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#beforeClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeClose(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called before all tasks in TaskRunner are closed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#beforeInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeInit(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called before all tasks in TaskRunner are initialized.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListener.html#beforeProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeProcess(IncomingMessageEnvelope, Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></dt> +<dd> +<div class="block">Called before a message is processed by a task.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></span> - Static variable in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></dt> +<dd> +<div class="block">A constant that can be used in the poll method's timeout parameter to + denote that the poll invocation should block until at least one message is + available for one of the SystemStreamPartitions supplied, or until all + SystemStreamPartitions supplied are at head (have no new messages available + since the last poll invocation was made for each SystemStreamPartition).</div> +</dd> +<dt><a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="strong">BlockingEnvelopeMap</span></a> - Class in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> +<dd> +<div class="block"> + BlockingEnvelopeMap is a helper class for SystemConsumer implementations.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap()">BlockingEnvelopeMap()</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.util.Clock)">BlockingEnvelopeMap(Clock)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap(MetricsRegistry)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock)">BlockingEnvelopeMap(MetricsRegistry, Clock)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock,%20java.lang.String)">BlockingEnvelopeMap(MetricsRegistry, Clock, String)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</span></a> - Class in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String,%20org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(String, MetricsRegistry)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">BlockingEnvelopeMap.BufferGauge</span></a> - Class in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">BlockingEnvelopeMap.BufferGauge(SystemStreamPartition, String)</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#buildCommand()">buildCommand()</a></span> - Method in class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#buildEnvironment()">buildEnvironment()</a></span> - Method in class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> +<dd> </dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><span class="strong">Checkpoint</span></a> - Class in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> +<dd> +<div class="block">A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/checkpoint/Checkpoint.html#Checkpoint(java.util.Map)">Checkpoint(Map<SystemStreamPartition, String>)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dd> +<div class="block">Constructs a new checkpoint based off a map of Samza stream offsets.</div> +</dd> +<dt><a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><span class="strong">CheckpointManager</span></a> - Interface in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> +<dd> +<div class="block">CheckpointManagers read and write <a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><code>Checkpoint</code></a> to some + implementation-specific location.</div> +</dd> +<dt><a href="./org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint"><span class="strong">CheckpointManagerFactory</span></a> - Interface in <a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> +<dd> +<div class="block">Build a <a href="./org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/chooser/MessageChooser.html#choose()">choose()</a></span> - Method in interface org.apache.samza.system.chooser.<a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dt> +<dd> +<div class="block">The choose method is invoked when the SamzaContainer is ready to process a + new message.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#clear()">clear()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#clear()">clear()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Clock</span></a> - Interface in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> +<dd> +<div class="block">Mockable interface for tracking time.</div> +</dd> +<dt><a href="./org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">ClosableTask</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> +<dd> +<div class="block">A ClosableTask augments <a href="./org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify + code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics, + clean or close resources, etc.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/ClosableTask.html#close()">close()</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job"><span class="strong">CommandBuilder</span></a> - Class in <a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#CommandBuilder()">CommandBuilder()</a></span> - Constructor for class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)">commit(TaskCoordinator.RequestScope)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></dt> +<dd> +<div class="block">Requests that Samza should write out a checkpoint, from which a task can restart + after failure.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet(T, T)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/TaskName.html#compareTo(org.apache.samza.container.TaskName)">compareTo(TaskName)</a></span> - Method in class org.apache.samza.container.<a href="./org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/Partition.html#compareTo(org.apache.samza.Partition)">compareTo(Partition)</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#compareTo(org.apache.samza.system.SystemStreamPartition)">compareTo(SystemStreamPartition)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Config</span></a> - Class in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#Config()">Config()</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/SamzaContainerContext.html#config">config</a></span> - Variable in class org.apache.samza.container.<a href="./org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#config">config</a></span> - Variable in class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">ConfigException</span></a> - Exception in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">Specific <a href="./org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.Throwable)">ConfigException(Throwable)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String)">ConfigException(String)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String,%20java.lang.Throwable)">ConfigException(String, Throwable)</a></span> - Constructor for exception org.apache.samza.config.<a href="./org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">ConfigFactory</span></a> - Interface in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">Build a <a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +</dd> +<dt><a href="./org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">ConfigRewriter</span></a> - Interface in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs, + remove existing configs or audit and verify the config is correct or permitted.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#containsKey(java.lang.Object)">containsKey(Object)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#containsValue(java.lang.Object)">containsValue(Object)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Counter</span></a> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<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.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#Counter(java.lang.String)">Counter(String)</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsVisitor.html#counter(org.apache.samza.metrics.Counter)">counter(Counter)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/Clock.html#currentTimeMillis()">currentTimeMillis()</a></span> - Method in interface org.apache.samza.util.<a href="./org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></dt> +<dd> </dd> +</dl> +<a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#dec()">dec()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#dec(long)">dec(long)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><span class="strong">Deserializer</span></a><<a href="./org/apache/samza/serializers/Deserializer.html" title="type parameter in Deserializer">T</a>> - Interface in <a href="./org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt> +<dd> +<div class="block">A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their + original form.</div> +</dd> +</dl> +<a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#entrySet()">entrySet()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/checkpoint/Checkpoint.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/TaskName.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.container.<a href="./org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/Partition.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +</dl> +<a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/storage/StorageEngine.html#flush()">flush()</a></span> - Method in interface org.apache.samza.storage.<a href="./org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage">StorageEngine</a></dt> +<dd> +<div class="block">Flush any cached messages</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush(String)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></dt> +<dd> +<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those + messages and leave no messages remaining to be sent.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/serializers/Deserializer.html#fromBytes(byte[])">fromBytes(byte[])</a></span> - Method in interface org.apache.samza.serializers.<a href="./org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers">Deserializer</a></dt> +<dd> +<div class="block">Deserializes given serialized object from an array of bytes to its original form.</div> +</dd> +</dl> +<a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Gauge</span></a><<a href="./org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a>> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<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.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#Gauge(java.lang.String,%20T)">Gauge(String, T)</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsVisitor.html#gauge(org.apache.samza.metrics.Gauge)">gauge(Gauge<T>)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#get(java.lang.String,%20java.lang.String)">get(String, String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#get(java.lang.Object)">get(Object)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemFactory.html#getAdmin(java.lang.String,%20org.apache.samza.config.Config)">getAdmin(String, Config)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Snapshot.html#getAverage()">getAverage()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> +<dd> +<div class="block">Get the average of the values in the collection</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getBoolean(java.lang.String,%20boolean)">getBoolean(String, boolean)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getBoolean(java.lang.String)">getBoolean(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/checkpoint/CheckpointManagerFactory.html#getCheckpointManager(org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getCheckpointManager(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint">CheckpointManagerFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/chooser/MessageChooserFactory.html#getChooser(org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getChooser(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.chooser.<a href="./org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser">MessageChooserFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/ConfigFactory.html#getConfig(java.net.URI)">getConfig(URI)</a></span> - Method in interface org.apache.samza.config.<a href="./org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config">ConfigFactory</a></dt> +<dd> +<div class="block">Build a specific Config.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemFactory.html#getConsumer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getConsumer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#getCount()">getCount()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String)">getDate(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String)">getDate(String, String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat)">getDate(String, SimpleDateFormat)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.util.Date)">getDate(String, Date)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String,%20java.util.Date)">getDate(String, String, Date)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat,%20java.util.Date)">getDate(String, SimpleDateFormat, Date)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDouble(java.lang.String,%20double)">getDouble(String, double)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getDouble(java.lang.String)">getDouble(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html#getGroup(java.lang.String)">getGroup(String)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html#getGroups()">getGroups()</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getInt(java.lang.String,%20int)">getInt(String, int)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getInt(java.lang.String)">getInt(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/StreamJobFactory.html#getJob(org.apache.samza.config.Config)">getJob(Config)</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job">StreamJobFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#getKey()">getKey()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getKey()">getKey()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName()">getKeySerializerName()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskLifecycleListenerFactory.html#getLifecyleListener(java.lang.String,%20org.apache.samza.config.Config)">getLifecyleListener(String, Config)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task">TaskLifecycleListenerFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getList(java.lang.String,%20java.util.List)">getList(String, List<String>)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getList(java.lang.String)">getList(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getLong(java.lang.String,%20long)">getLong(String, long)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getLong(java.lang.String)">getLong(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Snapshot.html#getMax()">getMax()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> +<dd> +<div class="block">Get the maximum value in the collection</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#getMessage()">getMessage()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage()">getMessage()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName()">getMessageSerializerName()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskContext.html#getMetricsRegistry()">getMetricsRegistry()</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsReporterFactory.html#getMetricsReporter(java.lang.String,%20java.lang.String,%20org.apache.samza.config.Config)">getMetricsReporter(String, String, Config)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics">MetricsReporterFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Snapshot.html#getMin()">getMin()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> +<dd> +<div class="block">Get the minimum value in the collection</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#getName()">getName()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#getName()">getName()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Timer.html#getName()">getName()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></dt> +<dd> +<div class="block">Get the name of the timer</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getNewestOffset()">getNewestOffset()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getNewInstance(java.lang.String)">getNewInstance(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue(org.apache.samza.system.SystemStreamPartition)">getNumMessagesInQueue(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#getOffset()">getOffset()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOffset(org.apache.samza.system.SystemStreamMetadata.OffsetType)">getOffset(SystemStreamMetadata.OffsetType)</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/checkpoint/Checkpoint.html#getOffsets()">getOffsets()</a></span> - Method in class org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dd> +<div class="block">Gets a unmodifiable view of the current Samza stream offsets.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemAdmin.html#getOffsetsAfter(java.util.Map)">getOffsetsAfter(Map<SystemStreamPartition, String>)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> +<dd> +<div class="block">Fetches the offsets for the messages immediately after the supplied offsets + for a group of SystemStreamPartitions.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html#getOffsetsAfter(java.util.Map)">getOffsetsAfter(Map<SystemStreamPartition, String>)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOldestOffset()">getOldestOffset()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#getPartition()">getPartition()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/Partition.html#getPartitionId()">getPartitionId()</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey()">getPartitionKey()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemFactory.html#getProducer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getProducer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/serializers/SerdeFactory.html#getSerde(java.lang.String,%20org.apache.samza.config.Config)">getSerde(String, Config)</a></span> - Method in interface org.apache.samza.serializers.<a href="./org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers">SerdeFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getShort(java.lang.String,%20short)">getShort(String, short)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort(String)</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Snapshot.html#getSize()">getSize()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> +<dd> +<div class="block">Get the number of values in the collection</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Reservoir.html#getSnapshot()">getSnapshot()</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></dt> +<dd> +<div class="block">Return a <a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of this reservoir</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/SlidingTimeWindowReservoir.html#getSnapshot()">getSnapshot()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics">SlidingTimeWindowReservoir</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Timer.html#getSnapshot()">getSnapshot()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></dt> +<dd> +<div class="block">Get the <a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#getStatus()">getStatus()</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/storage/StorageEngineFactory.html#getStorageEngine(java.lang.String,%20java.io.File,%20org.apache.samza.serializers.Serde,%20org.apache.samza.serializers.Serde,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.container.SamzaContainerContext)">getStorageEngine(String, File, Serde<K>, Serde<V>, MessageCollector, MetricsRegistry, SystemStreamPartition, SamzaContainerContext)</a></span> - Method in interface org.apache.samza.storage.<a href="./org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage">StorageEngineFactory</a></dt> +<dd> +<div class="block">Create an instance of the given storage engine.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskContext.html#getStore(java.lang.String)">getStore(String)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#getStream()">getStream()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.html#getStreamName()">getStreamName()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#getSystem()">getSystem()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#getSystemStream()">getSystemStream()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemAdmin.html#getSystemStreamMetadata(java.util.Set)">getSystemStreamMetadata(Set<String>)</a></span> - Method in interface org.apache.samza.system.<a href="./org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> +<dd> +<div class="block">Fetch metadata from a system for a set of streams.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html#getSystemStreamMetadata(java.util.Set)">getSystemStreamMetadata(Set<String>)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition()">getSystemStreamPartition()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html#getSystemStreamPartitionGrouper(org.apache.samza.config.Config)">getSystemStreamPartitionGrouper(Config)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="./org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionGrouperFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.html#getSystemStreamPartitionMetadata()">getSystemStreamPartitionMetadata()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskContext.html#getSystemStreamPartitions()">getSystemStreamPartitions()</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/TaskName.html#getTaskName()">getTaskName()</a></span> - Method in class org.apache.samza.container.<a href="./org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/TaskContext.html#getTaskName()">getTaskName()</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getUpcomingOffset()">getUpcomingOffset()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Gauge.html#getValue()">getValue()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#getValue()">getValue()</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Snapshot.html#getValues()">getValues()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> +<dd> +<div class="block">Return the entire list of values</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html#group(java.util.Set)">group(Set<SystemStreamPartition>)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="./org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionGrouper</a></dt> +<dd> </dd> +</dl> +<a name="_H_"> +<!-- --> +</a> +<h2 class="title">H</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#hash">hash</a></span> - Variable in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/checkpoint/Checkpoint.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.checkpoint.<a href="./org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/container/TaskName.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.container.<a href="./org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/Partition.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.<a href="./org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStream.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartition.html#hashCode()">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#hasNext()">hasNext()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt> +<dd> </dd> +</dl> +<a name="_I_"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#inc()">inc()</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/Counter.html#inc(long)">inc(long)</a></span> - Method in class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingPoll(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingTimeoutPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingTimeoutPoll(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">IncomingMessageEnvelope</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> +<dd> +<div class="block">This class represents a message envelope that is received by a StreamTask for each message that is received from a + partition of a specific input stream.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/system/IncomingMessageEnvelope.html#IncomingMessageEnvelope(org.apache.samza.system.SystemStreamPartition,%20java.lang.String,%20java.lang.Object,%20java.lang.Object)">IncomingMessageEnvelope(SystemStreamPartition, String, Object, Object)</a></span> - Constructor for class org.apache.samza.system.<a href="./org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> +<dd> +<div class="block">Constructs a new IncomingMessageEnvelope from specified components.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incPoll()">incPoll()</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/task/InitableTask.html#init(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">init(Config, TaskContext)</a></span> - Method in interface org.apache.samza.task.<a href="./org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></dt> +<dd> +<div class="block">Called by TaskRunner each time an implementing task is created.</div> +</dd> +<dt><a href="./org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">InitableTask</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> +<dd> +<div class="block">Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks + are instantiated by TaskRunner.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#initMetrics(org.apache.samza.system.SystemStreamPartition)">initMetrics(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#isAtHead(org.apache.samza.system.SystemStreamPartition)">isAtHead(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#isEmpty()">isEmpty()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +</dl> +<a name="_K_"> +<!-- --> +</a> +<h2 class="title">K</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#keySet()">keySet()</a></span> - Method in class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/StreamJob.html#kill()">kill()</a></span> - Method in interface org.apache.samza.job.<a href="./org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job">StreamJob</a></dt> +<dd> +<div class="block">Kill this job immediately.</div> +</dd> +</dl> +<a name="_L_"> +<!-- --> +</a> +<h2 class="title">L</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html#listen(org.apache.samza.metrics.ReadableMetricsRegistryListener)">listen(ReadableMetricsRegistryListener)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></dt> +<dd> </dd> +</dl> +<a name="_M_"> +<!-- --> +</a> +<h2 class="title">M</h2> +<dl> +<dt><a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="strong">MapConfig</span></a> - Class in <a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">A <a href="./org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> backed by a Java <code>Map</code></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#MapConfig()">MapConfig()</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#MapConfig(java.util.Map)">MapConfig(Map<String, String>)</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/config/MapConfig.html#MapConfig(java.util.List)">MapConfig(List<Map<String, String>>)</a></span> - Constructor for class org.apache.samza.config.<a href="./org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">MessageChooser</span></a> - Interface in <a href="./org/apache/samza/system/chooser/package-summary.html">org.apache.samza.system.chooser</a></dt> +<dd> +<div class="block">MessageChooser is an interface for programmatic fine-grain control over + stream consumption.</div> +</dd> +<dt><a href="./org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="strong">MessageChooserFactory</span></a> - Interface in <a href="./org/apache/samza/system/chooser/package-summary.html">org.apache.samza.system.chooser</a></dt> +<dd> +<div class="block">Build an instance of a <a href="./org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div> +</dd> +<dt><a href="./org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">MessageCollector</span></a> - Interface in <a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> +<dd> +<div class="block">Used as an interface for the means of sending message envelopes to an output stream.</div> +</dd> +<dt><a href="./org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Metric</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<div class="block">Metric class that allows metric visitors to visit it to get its information.</div> +</dd> +<dt><a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsRegistry</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<div class="block">A MetricsRegistry allows its users to create new <a href="./org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and + have those metrics wired to specific metrics systems, such as JMX, provided by <a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s.</div> +</dd> +<dt><a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporter</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<div class="block">A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive + metrics from the Samza framework and Samza jobs.</div> +</dd> +<dt><a href="./org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporterFactory</span></a> - Interface in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<div class="block">Build a <a href="./org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a></div> +</dd> +<dt><a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">MetricsVisitor</span></a> - Class in <a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a></dt> +<dd> +<div class="block">A MetricsVisitor can be used to process each metric in a <a href="./org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>ReadableMetricsRegistry</code></a>, + encapsulating the logic of what to be done with each metric in the counter and gauge methods.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsVisitor.html#MetricsVisitor()">MetricsVisitor()</a></span> - Constructor for class org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> +<dd> </dd> +</dl> +<a name="_N_"> +<!-- --> +</a> +<h2 class="title">N</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/container/SamzaContainerContext.html#name">name</a></span> - Variable in class org.apache.samza.container.<a href="./org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/job/CommandBuilder.html#name">name</a></span> - Variable in class org.apache.samza.job.<a href="./org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue()">newBlockingQueue()</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter(String, String)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Create and register a new <a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter(String, Counter)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Register existing <a href="./org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter(String, String)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter(String, Counter)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge(String, String, T)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Create and register a new <a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge(String, Gauge<T>)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Register an existing <a href="./org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge(String, String, T)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge(String, Gauge<T>)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer(String, String)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Create and Register a new <a href="./org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer(String, Timer)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></dt> +<dd> +<div class="block">Register existing <a href="./org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer(String, String)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer(String, Timer)</a></span> - Method in class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/system/SystemStreamPartitionIterator.html#next()">next()</a></span> - Method in class org.apache.samza.system.<a href="./org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="strong">NoOpMetricsRegistry</span></a> - Class in <a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> +<dd> +<div class="block"><a href="./org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be + recorded but a registry is still required.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/samza/util/NoOpMetricsRegistry.html#NoOpMetricsRegistry()">NoOpMetricsRegistry()</a></span> - Constructor for class org.apache.samza.util.<a href="./org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dt> +<dd> </dd> +</dl> +<a name="_O_"> +<!-- --> +</a> +<h2 class="title">O</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html#onCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">onCounter(String, Counter)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html#onGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">onGauge(String, Gauge<?>)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html#onTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">onTimer(String, Timer)</a></span> - Method in interface org.apache.samza.metrics.<a href="./org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</a></dt> +<dd> </dd> +<dt><a href="./org/apache/samza/package-summary.html">org.apache.samza</a> - package org.apache.samza</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a> - package org.apache.samza.checkpoint</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/config/package-summary.html">org.apache.samza.config</a> - package org.apache.samza.config</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/container/package-summary.html">org.apache.samza.container</a> - package org.apache.samza.container</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/container/grouper/stream/package-summary.html">org.apache.samza.container.grouper.stream</a> - package org.apache.samza.container.grouper.stream</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/job/package-summary.html">org.apache.samza.job</a> - package org.apache.samza.job</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/metrics/package-summary.html">org.apache.samza.metrics</a> - package org.apache.samza.metrics</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a> - package org.apache.samza.serializers</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/storage/package-summary.html">org.apache.samza.storage</a> - package org.apache.samza.storage</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a> - package org.apache.samza.system</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/system/chooser/package-summary.html">org.apache.samza.system.chooser</a> - package org.apache.samza.system.chooser</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/task/package-summary.html">org.apache.samza.task</a> - package org.apache.samza.task</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/util/package-summary.html">org.apache.samza.util</a> - package org.apache.samza.util</dt> +<dd> </dd> +<dt><a href="./org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">OutgoingMessageEnvelope</span></a> - Class in <a href="./org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> +<dd> +<div class="block">An OutgoingMessageEnvelope is sent to a specified <a href="./org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</co
<TRUNCATED>
