blob: dec1c7a16a681431c2eba49c6b54fad2d92cdfcc [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>JobTemplate (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="JobTemplate (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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/JobSpecSchedulerListenersContainer.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class 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/JobTemplate.html" target="_top">Frames</a></li>
<li><a href="JobTemplate.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>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 JobTemplate" class="title">Interface JobTemplate</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/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true" title="class or interface in gobblin.runtime.api">Spec</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/runtime/template/HOCONInputStreamJobTemplate.html" title="class in gobblin.runtime.template">HOCONInputStreamJobTemplate</a>, <a href="../../../gobblin/runtime/template/InheritingJobTemplate.html" title="class in gobblin.runtime.template">InheritingJobTemplate</a>, <a href="../../../gobblin/runtime/template/ResourceBasedJobTemplate.html" title="class in gobblin.runtime.template">ResourceBasedJobTemplate</a>, <a href="../../../gobblin/runtime/template/StaticJobTemplate.html" title="class in gobblin.runtime.template">StaticJobTemplate</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JobTemplate</span>
extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true" title="class or interface in gobblin.runtime.api">Spec</a></pre>
<div class="block">An interface for claiming methods used for
retrieving template configs
and properties that are required by user to fit in.
<p>
Each data source may have its own Job Template.
Examples are available based on requests.
</p></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">Interface 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/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</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="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="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobTemplate.html#getRawTemplateConfig--">getRawTemplateConfig</a></span>()</code>
<div class="block">Retrieve all configuration inside pre-written template.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobTemplate.html#getRequiredConfigList--">getRequiredConfigList</a></span>()</code>
<div class="block">Retrieve all configs that are required from user to fill.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/JobTemplate.html#getResolvedConfig-com.typesafe.config.Config-">getResolvedConfig</a></span>(<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;userProps)</code>
<div class="block">Return the combine configuration of template and user customized attributes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.api.Spec">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.runtime.api.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true" title="class or interface in gobblin.runtime.api">Spec</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true#getDescription--" title="class or interface in gobblin.runtime.api">getDescription</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true#getUri--" title="class or interface in gobblin.runtime.api">getUri</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/runtime/api/Spec.html?is-external=true#getVersion--" title="class or interface in gobblin.runtime.api">getVersion</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="getRawTemplateConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawTemplateConfig</h4>
<pre><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;getRawTemplateConfig()
throws <a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a>,
<a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</a></pre>
<div class="block">Retrieve all configuration inside pre-written template.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a></code></dd>
<dd><code><a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</a></code></dd>
</dl>
</li>
</ul>
<a name="getRequiredConfigList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredConfigList</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;&nbsp;getRequiredConfigList()
throws <a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a>,
<a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</a></pre>
<div class="block">Retrieve all configs that are required from user to fill.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a></code></dd>
<dd><code><a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</a></code></dd>
</dl>
</li>
</ul>
<a name="getResolvedConfig-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResolvedConfig</h4>
<pre><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;getResolvedConfig(<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;userProps)
throws <a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a>,
<a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</a></pre>
<div class="block">Return the combine configuration of template and user customized attributes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../gobblin/runtime/api/SpecNotFoundException.html" title="class in gobblin.runtime.api">SpecNotFoundException</a></code></dd>
<dd><code><a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class in gobblin.runtime.api">JobTemplate.TemplateException</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/JobSpecSchedulerListenersContainer.html" title="interface in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/JobTemplate.TemplateException.html" title="class 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/JobTemplate.html" target="_top">Frames</a></li>
<li><a href="JobTemplate.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>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>