blob: 11b20e0a655f084433448615ced7a0171edcb017 [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>JobExecutionDriver (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="JobExecutionDriver (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/JobExecution.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobExecutionLauncher.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/JobExecutionDriver.html" target="_top">Frames</a></li>
<li><a href="JobExecutionDriver.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 JobExecutionDriver" class="title">Interface JobExecutionDriver</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;, <a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html" title="interface in gobblin.runtime.api">JobExecutionStateListenerContainer</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/ListenableFuture.html?is-external=true" title="class or interface in com.google.common.util.concurrent">ListenableFuture</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;, <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>, <a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/RunnableFuture.html?is-external=true" title="class or interface in java.util.concurrent">RunnableFuture</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/runtime/job_exec/JobLauncherExecutionDriver.html" title="class in gobblin.runtime.job_exec">JobLauncherExecutionDriver</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JobExecutionDriver</span>
extends <a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html" title="interface in gobblin.runtime.api">JobExecutionStateListenerContainer</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/ListenableFuture.html?is-external=true" title="class or interface in com.google.common.util.concurrent">ListenableFuture</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;, <a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/RunnableFuture.html?is-external=true" title="class or interface in java.util.concurrent">RunnableFuture</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;</pre>
<div class="block">Defines an implementation which knows how to run a GobblinJob and keep track of the progress.
<p> The class utilizes the <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true" title="class or interface in com.google.common.util.concurrent"><code>Service</code></a> interface.
<ul>
<li> <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#startAsync--" title="class or interface in com.google.common.util.concurrent"><code>Service.startAsync()</code></a> starts the execution.
<li> <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#stopAsync--" title="class or interface in com.google.common.util.concurrent"><code>Service.stopAsync()</code></a> cancels the execution if running; if the job has completed, it
is a NO-OP
<li> <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#awaitTerminated-long-java.util.concurrent.TimeUnit-" title="class or interface in com.google.common.util.concurrent"><code>Service.awaitTerminated(long, java.util.concurrent.TimeUnit)</code></a> - waits for the job
to complete or get canceled.
<ul></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="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobExecutionDriver.html#get--">get</a></span>()</code></td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobExecutionDriver.html#get-long-java.util.concurrent.TimeUnit-">get</a></span>(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code></td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobExecution.html" title="interface in gobblin.runtime.api">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobExecutionDriver.html#getJobExecution--">getJobExecution</a></span>()</code>
<div class="block">The job execution ID</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobExecutionState.html" title="class in gobblin.runtime.api">JobExecutionState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobExecutionDriver.html#getJobExecutionState--">getJobExecutionState</a></span>()</code>
<div class="block">The job execution state</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/runtime/api/JobExecutionStatus.html" title="interface in gobblin.runtime.api">JobExecutionStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobExecutionDriver.html#getJobExecutionStatus--">getJobExecutionStatus</a></span>()</code>
<div class="block">The job execution status</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.api.JobExecutionStateListenerContainer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.runtime.api.<a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html" title="interface in gobblin.runtime.api">JobExecutionStateListenerContainer</a></h3>
<code><a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html#registerStateListener-gobblin.runtime.api.JobExecutionStateListener-">registerStateListener</a>, <a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html#registerWeakStateListener-gobblin.runtime.api.JobExecutionStateListener-">registerWeakStateListener</a>, <a href="../../../gobblin/runtime/api/JobExecutionStateListenerContainer.html#unregisterStateListener-gobblin.runtime.api.JobExecutionStateListener-">unregisterStateListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.common.util.concurrent.ListenableFuture">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.common.util.concurrent.<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/ListenableFuture.html?is-external=true" title="class or interface in com.google.common.util.concurrent">ListenableFuture</a></h3>
<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/ListenableFuture.html?is-external=true#addListener-java.lang.Runnable-java.util.concurrent.Executor-" title="class or interface in com.google.common.util.concurrent">addListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.concurrent.RunnableFuture">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.concurrent.<a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/RunnableFuture.html?is-external=true" title="class or interface in java.util.concurrent">RunnableFuture</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/RunnableFuture.html?is-external=true#run--" title="class or interface in java.util.concurrent">run</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.concurrent.Future">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.concurrent.<a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#cancel-boolean-" title="class or interface in java.util.concurrent">cancel</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#isCancelled--" title="class or interface in java.util.concurrent">isCancelled</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#isDone--" title="class or interface in java.util.concurrent">isDone</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="getJobExecution--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobExecution</h4>
<pre><a href="../../../gobblin/runtime/api/JobExecution.html" title="interface in gobblin.runtime.api">JobExecution</a>&nbsp;getJobExecution()</pre>
<div class="block">The job execution ID</div>
</li>
</ul>
<a name="getJobExecutionStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobExecutionStatus</h4>
<pre><a href="../../../gobblin/runtime/api/JobExecutionStatus.html" title="interface in gobblin.runtime.api">JobExecutionStatus</a>&nbsp;getJobExecutionStatus()</pre>
<div class="block">The job execution status</div>
</li>
</ul>
<a name="getJobExecutionState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobExecutionState</h4>
<pre><a href="../../../gobblin/runtime/api/JobExecutionState.html" title="class in gobblin.runtime.api">JobExecutionState</a>&nbsp;getJobExecutionState()</pre>
<div class="block">The job execution state</div>
</li>
</ul>
<a name="get--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&nbsp;get()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#get--" title="class or interface in java.util.concurrent">get</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
</dl>
</li>
</ul>
<a name="get-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&nbsp;get(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#get-long-java.util.concurrent.TimeUnit-" title="class or interface in java.util.concurrent">get</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="../../../gobblin/runtime/api/JobExecutionResult.html" title="class in gobblin.runtime.api">JobExecutionResult</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<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/JobExecution.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobExecutionLauncher.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/JobExecutionDriver.html" target="_top">Frames</a></li>
<li><a href="JobExecutionDriver.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>