blob: 9163c3926e551f1d1839da96583de3cbae4ff7a5 [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:20 PDT 2017 -->
<title>JobSpecScheduler (gobblin-runtime 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="JobSpecScheduler (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobSpecSchedulerListener.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/runtime/api/JobSpecScheduler.html" target="_top">Frames</a></li>
<li><a href="JobSpecScheduler.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">gobblin.runtime.api</div>
<h2 title="Interface JobSpecScheduler" class="title">Interface JobSpecScheduler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html" title="interface in gobblin.runtime.api">JobSpecSchedulerListenersContainer</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/runtime/scheduler/AbstractJobSpecScheduler.html" title="class in gobblin.runtime.scheduler">AbstractJobSpecScheduler</a>, <a href="../../../gobblin/runtime/scheduler/ImmediateJobSpecScheduler.html" title="class in gobblin.runtime.scheduler">ImmediateJobSpecScheduler</a>, <a href="../../../gobblin/runtime/scheduler/QuartzJobSpecScheduler.html" title="class in gobblin.runtime.scheduler">QuartzJobSpecScheduler</a></dd>
</dl>
<hr>
<br>
<pre><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/annotation/Alpha.html?is-external=true" title="class or interface in gobblin.annotation">@Alpha</a>
public interface <span class="typeNameLabel">JobSpecScheduler</span>
extends <a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html" title="interface in gobblin.runtime.api">JobSpecSchedulerListenersContainer</a></pre>
<div class="block">Early alpha of the scheduler interface which is responsible of deciding when to run next the
GobblinJob identified by a JobSpec. The scheduler maintains one <a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api"><code>JobSpecSchedule</code></a> per
JobSpec URI. Which means that scheduling a new version of JobSpec will override the schedule of
the previous version.
The scheduler is fire-and-forget. It is caller's responsibility (typically,
<a href="../../../gobblin/runtime/api/GobblinInstanceDriver.html" title="interface in gobblin.runtime.api"><code>GobblinInstanceDriver</code></a>) to keep track of the outcome of the execution.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>,<a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobSpecScheduler.html#getSchedules--">getSchedules</a></span>()</code>
<div class="block">The outstanding job schedules.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobSpecScheduler.html#scheduleJob-gobblin.runtime.api.JobSpec-java.lang.Runnable-">scheduleJob</a></span>(<a href="../../../gobblin/runtime/api/JobSpec.html" title="class in gobblin.runtime.api">JobSpec</a>&nbsp;jobSpec,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;jobRunnable)</code>
<div class="block">Add a Gobblin job for scheduling.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobSpecScheduler.html#scheduleOnce-gobblin.runtime.api.JobSpec-java.lang.Runnable-">scheduleOnce</a></span>(<a href="../../../gobblin/runtime/api/JobSpec.html" title="class in gobblin.runtime.api">JobSpec</a>&nbsp;jobSpec,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;jobRunnable)</code>
<div class="block">Add a Gobblin job for scheduling.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobSpecScheduler.html#unscheduleJob-java.net.URI-">unscheduleJob</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;jobSpecURI)</code>
<div class="block">Remove a job from scheduling.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.api.JobSpecSchedulerListenersContainer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.runtime.api.<a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html" title="interface in gobblin.runtime.api">JobSpecSchedulerListenersContainer</a></h3>
<code><a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html#getJobSpecSchedulerListeners--">getJobSpecSchedulerListeners</a>, <a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html#registerJobSpecSchedulerListener-gobblin.runtime.api.JobSpecSchedulerListener-">registerJobSpecSchedulerListener</a>, <a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html#registerWeakJobSpecSchedulerListener-gobblin.runtime.api.JobSpecSchedulerListener-">registerWeakJobSpecSchedulerListener</a>, <a href="../../../gobblin/runtime/api/JobSpecSchedulerListenersContainer.html#unregisterJobSpecSchedulerListener-gobblin.runtime.api.JobSpecSchedulerListener-">unregisterJobSpecSchedulerListener</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="scheduleJob-gobblin.runtime.api.JobSpec-java.lang.Runnable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleJob</h4>
<pre><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a>&nbsp;scheduleJob(<a href="../../../gobblin/runtime/api/JobSpec.html" title="class in gobblin.runtime.api">JobSpec</a>&nbsp;jobSpec,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;jobRunnable)</pre>
<div class="block">Add a Gobblin job for scheduling. If the job is configured appropriately (scheduler-dependent),
it will be executed repeatedly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobSpec</code> - the JobSpec of the job</dd>
<dd><code>jobRunnable</code> - a runnable that will execute the job</dd>
</dl>
</li>
</ul>
<a name="scheduleOnce-gobblin.runtime.api.JobSpec-java.lang.Runnable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleOnce</h4>
<pre><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a>&nbsp;scheduleOnce(<a href="../../../gobblin/runtime/api/JobSpec.html" title="class in gobblin.runtime.api">JobSpec</a>&nbsp;jobSpec,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;jobRunnable)</pre>
<div class="block">Add a Gobblin job for scheduling. Job is guaranteed to run only once regardless of job outcome.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobSpec</code> - the JobSpec of the job</dd>
<dd><code>jobRunnable</code> - a runnable that will execute the job</dd>
</dl>
</li>
</ul>
<a name="unscheduleJob-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unscheduleJob</h4>
<pre>void&nbsp;unscheduleJob(<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;jobSpecURI)</pre>
<div class="block">Remove a job from scheduling. This will not affect any executions that are currently running.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobSpecURI</code> - the URI of the Gobblin job to unschedule.</dd>
</dl>
</li>
</ul>
<a name="getSchedules--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSchedules</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>,<a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api">JobSpecSchedule</a>&gt;&nbsp;getSchedules()</pre>
<div class="block">The outstanding job schedules. This is represents a snapshot in time and will not be updated
as new schedules are added/removed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map with the URIs of the scheduled jobs for keys and the schedules for values</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/runtime/api/JobSpecSchedule.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobSpecSchedulerListener.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/runtime/api/JobSpecScheduler.html" target="_top">Frames</a></li>
<li><a href="JobSpecScheduler.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>