blob: c5e08d90b97be108e8577609710d76d9c8b68212 [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:46 PDT 2017 -->
<title>RetentionAction.RetentionActionFactory (gobblin-data-management 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="RetentionAction.RetentionActionFactory (gobblin-data-management 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/data/management/retention/action/RetentionAction.RetentionActionFactory.html" target="_top">Frames</a></li>
<li><a href="RetentionAction.RetentionActionFactory.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.data.management.retention.action</div>
<h2 title="Interface RetentionAction.RetentionActionFactory" class="title">Interface RetentionAction.RetentionActionFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../gobblin/data/management/retention/action/MultiAccessControlAction.MultiAccessControlActionFactory.html" title="class in gobblin.data.management.retention.action">MultiAccessControlAction.MultiAccessControlActionFactory</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action">RetentionAction</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">RetentionAction.RetentionActionFactory</span></pre>
<div class="block">A factory to create new <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a>s</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/action/RetentionAction.RetentionActionFactory.html#canCreateWithConfig-com.typesafe.config.Config-">canCreateWithConfig</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;config)</code>
<div class="block">Method to check if a <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> can be created/instantiated with the <code>config</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action">RetentionAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/action/RetentionAction.RetentionActionFactory.html#createRetentionAction-com.typesafe.config.Config-org.apache.hadoop.fs.FileSystem-com.typesafe.config.Config-">createRetentionAction</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;config,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<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;jobConfig)</code>
<div class="block">A factory method to create a new <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> using a <code>config</code>.</div>
</td>
</tr>
</table>
</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="createRetentionAction-com.typesafe.config.Config-org.apache.hadoop.fs.FileSystem-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRetentionAction</h4>
<pre><a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action">RetentionAction</a>&nbsp;createRetentionAction(<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;config,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<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;jobConfig)</pre>
<div class="block">A factory method to create a new <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> using a <code>config</code>. The <a href="../../../../../gobblin/data/management/dataset/Dataset.html" title="interface in gobblin.data.management.dataset"><code>Dataset</code></a> always
calls <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.RetentionActionFactory.html#canCreateWithConfig-com.typesafe.config.Config-"><code>canCreateWithConfig(Config)</code></a> before calling this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - to use to create the <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a></dd>
</dl>
</li>
</ul>
<a name="canCreateWithConfig-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>canCreateWithConfig</h4>
<pre>boolean&nbsp;canCreateWithConfig(<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;config)</pre>
<div class="block">Method to check if a <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> can be created/instantiated with the <code>config</code>.
If the specific type of <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> has been specified in the configuration the method returns
<code>true</code>
If the method returns <code>true</code>, <code>#createRetentionAction(Config, FileSystem)</code> can be called to create
this <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - to use to create the <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a></dd>
<dd><code>jobConfig</code> - is the job level config</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the specific type of <a href="../../../../../gobblin/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><code>RetentionAction</code></a> has been specified in the configuration, false otherwise</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/data/management/retention/action/RetentionAction.html" title="class in gobblin.data.management.retention.action"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/data/management/retention/action/RetentionAction.RetentionActionFactory.html" target="_top">Frames</a></li>
<li><a href="RetentionAction.RetentionActionFactory.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>