blob: 5a57eff3187a6d72578899bd10351797f1e488ad [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:18:33 PDT 2017 -->
<title>gobblin.cluster (gobblin-cluster 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="gobblin.cluster (gobblin-cluster 0.11.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../gobblin/cluster/event/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/cluster/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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&nbsp;gobblin.cluster</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</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="../../gobblin/cluster/ClusterEventMetadataGenerator.html" title="class in gobblin.cluster">ClusterEventMetadataGenerator</a></td>
<td class="colLast">
<div class="block"><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/EventMetadataGenerator.html?is-external=true" title="class or interface in gobblin.runtime.api"><code>EventMetadataGenerator</code></a> that outputs the processed message count and error messages
used for job status tracking</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/ContainerMetrics.html" title="class in gobblin.cluster">ContainerMetrics</a></td>
<td class="colLast">
<div class="block">Extension of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-metrics/gobblin/metrics/GobblinMetrics.html?is-external=true" title="class or interface in gobblin.metrics"><code>GobblinMetrics</code></a> specifically for <a href="../../gobblin/cluster/GobblinTaskRunner.html" title="class in gobblin.cluster"><code>GobblinTaskRunner</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinClusterConfigurationKeys.html" title="class in gobblin.cluster">GobblinClusterConfigurationKeys</a></td>
<td class="colLast">
<div class="block">A central place for configuration related constants of a Gobblin Cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinClusterManager.html" title="class in gobblin.cluster">GobblinClusterManager</a></td>
<td class="colLast">
<div class="block">The central cluster manager for Gobblin Clusters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinClusterMetricTagNames.html" title="class in gobblin.cluster">GobblinClusterMetricTagNames</a></td>
<td class="colLast">
<div class="block">A central place for constants of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-metrics/gobblin/metrics/MetricContext.html?is-external=true" title="class or interface in gobblin.metrics"><code>MetricContext</code></a> tag names for a Gobblin cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinClusterUtils.html" title="class in gobblin.cluster">GobblinClusterUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixConstants.html" title="class in gobblin.cluster">GobblinHelixConstants</a></td>
<td class="colLast">
<div class="block">Class for defining constants used while interacting with Helix</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixJob.html" title="class in gobblin.cluster">GobblinHelixJob</a></td>
<td class="colLast">
<div class="block">An implementation of a Quartz's <code>Job</code> that uses a <a href="../../gobblin/cluster/GobblinHelixJobLauncher.html" title="class in gobblin.cluster"><code>GobblinHelixJobLauncher</code></a>
to launch a Gobblin job.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixJobLauncher.html" title="class in gobblin.cluster">GobblinHelixJobLauncher</a></td>
<td class="colLast">
<div class="block">An implementation of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-runtime/gobblin/runtime/JobLauncher.html?is-external=true" title="class or interface in gobblin.runtime"><code>JobLauncher</code></a> that launches a Gobblin job using the Helix task framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixJobScheduler.html" title="class in gobblin.cluster">GobblinHelixJobScheduler</a></td>
<td class="colLast">
<div class="block">An extension to <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-runtime/gobblin/scheduler/JobScheduler.html?is-external=true" title="class or interface in gobblin.scheduler"><code>JobScheduler</code></a> that schedules and runs Gobblin jobs on Helix using
<a href="../../gobblin/cluster/GobblinHelixJobLauncher.html" title="class in gobblin.cluster"><code>GobblinHelixJobLauncher</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixMessagingService.html" title="class in gobblin.cluster">GobblinHelixMessagingService</a></td>
<td class="colLast">
<div class="block">#HELIX-0.6.7-WORKAROUND
The GobblinHelixMessagingService is a temporary workaround for missing messaging support for INSTANCES in helix 0.6.7</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixMessagingService.GobblinHelixCriteriaEvaluator.html" title="class in gobblin.cluster">GobblinHelixMessagingService.GobblinHelixCriteriaEvaluator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixTask.html" title="class in gobblin.cluster">GobblinHelixTask</a></td>
<td class="colLast">
<div class="block">An implementation of Helix's <code>Task</code> that wraps and runs one or more Gobblin
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-runtime/gobblin/runtime/Task.html?is-external=true" title="class or interface in gobblin.runtime"><code>Task</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixTaskDriver.html" title="class in gobblin.cluster">GobblinHelixTaskDriver</a></td>
<td class="colLast">
<div class="block">#HELIX-0.6.7-WORKAROUND
Replacement TaskDriver methods to workaround bugs and changes in behavior for the 0.6.7 upgrade</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixTaskFactory.html" title="class in gobblin.cluster">GobblinHelixTaskFactory</a></td>
<td class="colLast">
<div class="block">An implementation of Helix's <code>TaskFactory</code> for <a href="../../gobblin/cluster/GobblinHelixTask.html" title="class in gobblin.cluster"><code>GobblinHelixTask</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinHelixTaskStateTracker.html" title="class in gobblin.cluster">GobblinHelixTaskStateTracker</a></td>
<td class="colLast">
<div class="block">A concrete extension to <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-runtime/gobblin/runtime/AbstractTaskStateTracker.html?is-external=true" title="class or interface in gobblin.runtime"><code>AbstractTaskStateTracker</code></a> for a Gobblin Cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinTaskRunner.html" title="class in gobblin.cluster">GobblinTaskRunner</a></td>
<td class="colLast">
<div class="block">The main class running in the containers managing services for running Gobblin
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit"><code>WorkUnit</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinTaskStateModel.html" title="class in gobblin.cluster">GobblinTaskStateModel</a></td>
<td class="colLast">
<div class="block">A state model for a Gobblin task that implements all supported state transitions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/GobblinTaskStateModelFactory.html" title="class in gobblin.cluster">GobblinTaskStateModelFactory</a></td>
<td class="colLast">
<div class="block">A <code>TaskStateModelFactory</code> for <a href="../../gobblin/cluster/GobblinTaskStateModel.html" title="class in gobblin.cluster"><code>GobblinTaskStateModel</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/HelixUtils.html" title="class in gobblin.cluster">HelixUtils</a></td>
<td class="colLast">
<div class="block">A utility class for working with Gobblin on Helix.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/JobConfigurationManager.html" title="class in gobblin.cluster">JobConfigurationManager</a></td>
<td class="colLast">
<div class="block">A class for managing Gobblin job configurations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/NoopReplyHandler.html" title="class in gobblin.cluster">NoopReplyHandler</a></td>
<td class="colLast">
<div class="block">Class that handles Helix messaging response via no-op.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/cluster/ScheduledJobConfigurationManager.html" title="class in gobblin.cluster">ScheduledJobConfigurationManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/cluster/StreamingJobConfigurationManager.html" title="class in gobblin.cluster">StreamingJobConfigurationManager</a></td>
<td class="colLast">
<div class="block">A <a href="../../gobblin/cluster/JobConfigurationManager.html" title="class in gobblin.cluster"><code>JobConfigurationManager</code></a> that fetches job specs from a <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/SpecExecutorInstanceConsumer.html?is-external=true" title="class or interface in gobblin.runtime.api"><code>SpecExecutorInstanceConsumer</code></a> in a loop
without</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</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="../../gobblin/cluster/HelixMessageSubTypes.html" title="enum in gobblin.cluster">HelixMessageSubTypes</a></td>
<td class="colLast">
<div class="block">An enumeration of Helix message sub types.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../gobblin/cluster/event/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/cluster/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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>