blob: cacc806501542c9cc631c81e14c7f2b3c4f95365 [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>GobblinInstancePlugin (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="GobblinInstancePlugin (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/GobblinInstanceLauncher.ConfigAccessor.html" title="class in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/GobblinInstancePluginFactory.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/GobblinInstancePlugin.html" target="_top">Frames</a></li>
<li><a href="GobblinInstancePlugin.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 GobblinInstancePlugin" class="title">Interface GobblinInstancePlugin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><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">Service</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/runtime/instance/plugin/BaseIdlePluginImpl.html" title="class in gobblin.runtime.instance.plugin">BaseIdlePluginImpl</a>, <a href="../../../gobblin/runtime/plugins/email/EmailNotificationPlugin.html" title="class in gobblin.runtime.plugins.email">EmailNotificationPlugin</a>, <a href="../../../gobblin/runtime/plugins/metrics/GobblinMetricsPlugin.html" title="class in gobblin.runtime.plugins.metrics">GobblinMetricsPlugin</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GobblinInstancePlugin</span>
extends <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">Service</a></pre>
<div class="block">The interfaces for Gobblin instance plugins. Plugins are objects the share configuration and
lifespan with a specific Gobblin instance and can be used to extend its functionality. Examples
of plugins maybe providing a REST interface, authentication and so on.</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Nested classes/interfaces 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/Service.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service</a></h3>
<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.Listener.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service.Listener</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.State.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service.State</a></code></li>
</ul>
</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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/api/GobblinInstancePlugin.html#toString--">toString</a></span>()</code>
<div class="block">Override this method to provide a human-readable description of the plugin</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</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/Service.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service</a></h3>
<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#addListener-com.google.common.util.concurrent.Service.Listener-java.util.concurrent.Executor-" title="class or interface in com.google.common.util.concurrent">addListener</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#awaitRunning--" title="class or interface in com.google.common.util.concurrent">awaitRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#awaitRunning-long-java.util.concurrent.TimeUnit-" title="class or interface in com.google.common.util.concurrent">awaitRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#awaitTerminated--" title="class or interface in com.google.common.util.concurrent">awaitTerminated</a>, <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">awaitTerminated</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#failureCause--" title="class or interface in com.google.common.util.concurrent">failureCause</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#isRunning--" title="class or interface in com.google.common.util.concurrent">isRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#start--" title="class or interface in com.google.common.util.concurrent">start</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#startAndWait--" title="class or interface in com.google.common.util.concurrent">startAndWait</a>, <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">startAsync</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#state--" title="class or interface in com.google.common.util.concurrent">state</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#stop--" title="class or interface in com.google.common.util.concurrent">stop</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true#stopAndWait--" title="class or interface in com.google.common.util.concurrent">stopAndWait</a>, <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">stopAsync</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="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre><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;toString()</pre>
<div class="block">Override this method to provide a human-readable description of the plugin</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></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/GobblinInstanceLauncher.ConfigAccessor.html" title="class in gobblin.runtime.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/api/GobblinInstancePluginFactory.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/GobblinInstancePlugin.html" target="_top">Frames</a></li>
<li><a href="GobblinInstancePlugin.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>