blob: a257c489b92bca352c69817dfa7e8b8eda6a8ded [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:17 PDT 2017 -->
<title>JobLauncherFactory (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="JobLauncherFactory (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/JobLauncher.html" title="interface in gobblin.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/runtime/JobLauncherFactory.JobLauncherType.html" title="enum in gobblin.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/runtime/JobLauncherFactory.html" target="_top">Frames</a></li>
<li><a href="JobLauncherFactory.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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</div>
<h2 title="Class JobLauncherFactory" class="title">Class JobLauncherFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>gobblin.runtime.JobLauncherFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JobLauncherFactory</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A factory class for building <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a> instances.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/runtime/JobLauncherFactory.JobLauncherType.html" title="enum in gobblin.runtime">JobLauncherFactory.JobLauncherType</a></span></code>
<div class="block">Supported types of <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../gobblin/runtime/JobLauncherFactory.html#JobLauncherFactory--">JobLauncherFactory</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/runtime/JobLauncherFactory.html#newJobLauncher-java.util.Properties-java.util.Properties-">newJobLauncher</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps)</code>
<div class="block">Create a new <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/runtime/JobLauncherFactory.html#newJobLauncher-java.util.Properties-java.util.Properties-gobblin.broker.iface.SharedResourcesBroker-">newJobLauncher</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/iface/SharedResourcesBroker.html?is-external=true" title="class or interface in gobblin.broker.iface">SharedResourcesBroker</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/gobblin_scopes/GobblinScopeTypes.html?is-external=true" title="class or interface in gobblin.broker.gobblin_scopes">GobblinScopeTypes</a>&gt;&nbsp;instanceBroker)</code>
<div class="block">Create a new <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/runtime/JobLauncherFactory.html#newJobLauncher-java.util.Properties-java.util.Properties-java.lang.String-gobblin.broker.iface.SharedResourcesBroker-">newJobLauncher</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;launcherTypeValue,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/iface/SharedResourcesBroker.html?is-external=true" title="class or interface in gobblin.broker.iface">SharedResourcesBroker</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/gobblin_scopes/GobblinScopeTypes.html?is-external=true" title="class or interface in gobblin.broker.gobblin_scopes">GobblinScopeTypes</a>&gt;&nbsp;instanceBroker)</code>
<div class="block">Creates a new instance for a JobLauncher with a given type</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JobLauncherFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JobLauncherFactory</h4>
<pre>public&nbsp;JobLauncherFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newJobLauncher-java.util.Properties-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newJobLauncher</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public static&nbsp;<a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a>&nbsp;newJobLauncher(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Create a new <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a>.
<p>
This method will never return a <code>null</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sysProps</code> - system configuration properties</dd>
<dd><code>jobProps</code> - job configuration properties</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly created <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="newJobLauncher-java.util.Properties-java.util.Properties-gobblin.broker.iface.SharedResourcesBroker-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newJobLauncher</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public static&nbsp;<a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a>&nbsp;newJobLauncher(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/iface/SharedResourcesBroker.html?is-external=true" title="class or interface in gobblin.broker.iface">SharedResourcesBroker</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/gobblin_scopes/GobblinScopeTypes.html?is-external=true" title="class or interface in gobblin.broker.gobblin_scopes">GobblinScopeTypes</a>&gt;&nbsp;instanceBroker)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Create a new <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a>.
<p>
This method will never return a <code>null</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sysProps</code> - system configuration properties</dd>
<dd><code>jobProps</code> - job configuration properties</dd>
<dd><code>instanceBroker</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly created <a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime"><code>JobLauncher</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="newJobLauncher-java.util.Properties-java.util.Properties-java.lang.String-gobblin.broker.iface.SharedResourcesBroker-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newJobLauncher</h4>
<pre>public static&nbsp;<a href="../../gobblin/runtime/JobLauncher.html" title="interface in gobblin.runtime">JobLauncher</a>&nbsp;newJobLauncher(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;sysProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;jobProps,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;launcherTypeValue,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/iface/SharedResourcesBroker.html?is-external=true" title="class or interface in gobblin.broker.iface">SharedResourcesBroker</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/broker/gobblin_scopes/GobblinScopeTypes.html?is-external=true" title="class or interface in gobblin.broker.gobblin_scopes">GobblinScopeTypes</a>&gt;&nbsp;instanceBroker)</pre>
<div class="block">Creates a new instance for a JobLauncher with a given type</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sysProps</code> - the system/environment properties</dd>
<dd><code>jobProps</code> - the job properties</dd>
<dd><code>launcherTypeValue</code> - the type of the launcher; either a <a href="../../gobblin/runtime/JobLauncherFactory.JobLauncherType.html" title="enum in gobblin.runtime"><code>JobLauncherFactory.JobLauncherType</code></a> value or
the name of the class that extends <a href="../../gobblin/runtime/AbstractJobLauncher.html" title="class in gobblin.runtime"><code>AbstractJobLauncher</code></a> and has a constructor
that has a single Properties parameter..</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the JobLauncher instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the instantiation fails</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/JobLauncher.html" title="interface in gobblin.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/runtime/JobLauncherFactory.JobLauncherType.html" title="enum in gobblin.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/runtime/JobLauncherFactory.html" target="_top">Frames</a></li>
<li><a href="JobLauncherFactory.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>