blob: f84a2eeb265b0613f7dc974f19bf46b06e07ab45 [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:48 PDT 2017 -->
<title>ConfigurableGlobDatasetFinder (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="ConfigurableGlobDatasetFinder (gobblin-data-management 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/data/management/retention/profile/ConfigBasedCleanabledDatasetFinder.html" title="class in gobblin.data.management.retention.profile"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../gobblin/data/management/retention/profile/GlobCleanableDatasetFinder.html" title="class in gobblin.data.management.retention.profile"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" target="_top">Frames</a></li>
<li><a href="ConfigurableGlobDatasetFinder.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.data.management.retention.profile</div>
<h2 title="Class ConfigurableGlobDatasetFinder" class="title">Class ConfigurableGlobDatasetFinder&lt;T extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/Dataset.html?is-external=true" title="class or interface in gobblin.dataset">Dataset</a>&gt;</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.data.management.retention.profile.ConfigurableGlobDatasetFinder&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true" title="class or interface in gobblin.dataset">DatasetsFinder</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../gobblin/data/management/copy/CopyableGlobDatasetFinder.html" title="class in gobblin.data.management.copy">CopyableGlobDatasetFinder</a>, <a href="../../../../../gobblin/data/management/dataset/DefaultFileSystemGlobFinder.html" title="class in gobblin.data.management.dataset">DefaultFileSystemGlobFinder</a>, <a href="../../../../../gobblin/data/management/retention/profile/GlobCleanableDatasetFinder.html" title="class in gobblin.data.management.retention.profile">GlobCleanableDatasetFinder</a>, <a href="../../../../../gobblin/data/management/retention/profile/ManagedCleanableDatasetFinder.html" title="class in gobblin.data.management.retention.profile">ManagedCleanableDatasetFinder</a>, <a href="../../../../../gobblin/data/management/retention/profile/ModificationTimeDatasetProfile.html" title="class in gobblin.data.management.retention.profile">ModificationTimeDatasetProfile</a>, <a href="../../../../../gobblin/data/management/retention/profile/ProxyableDatasetProfile.html" title="class in gobblin.data.management.retention.profile">ProxyableDatasetProfile</a>, <a href="../../../../../gobblin/data/management/retention/profile/SnapshotDatasetProfile.html" title="class in gobblin.data.management.retention.profile">SnapshotDatasetProfile</a>, <a href="../../../../../gobblin/data/management/copy/SubsetFilesCopyableDatasetFinder.html" title="class in gobblin.data.management.copy">SubsetFilesCopyableDatasetFinder</a>, <a href="../../../../../gobblin/data/management/retention/profile/TrackingDatasetProfile.html" title="class in gobblin.data.management.retention.profile">TrackingDatasetProfile</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ConfigurableGlobDatasetFinder&lt;T extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/Dataset.html?is-external=true" title="class or interface in gobblin.dataset">Dataset</a>&gt;</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>
implements <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true" title="class or interface in gobblin.dataset">DatasetsFinder</a>&lt;T&gt;</pre>
<div class="block">A configurable <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true" title="class or interface in gobblin.dataset"><code>DatasetsFinder</code></a> that looks for
<a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a>s using a glob pattern.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#DATASET_BLACKLIST_KEY">DATASET_BLACKLIST_KEY</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#DATASET_FINDER_BLACKLIST_KEY">DATASET_FINDER_BLACKLIST_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#DATASET_FINDER_PATTERN_KEY">DATASET_FINDER_PATTERN_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#DATASET_PATTERN_KEY">DATASET_PATTERN_KEY</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#datasetPattern">datasetPattern</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#fs">fs</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#props">props</a></span></code>&nbsp;</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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#ConfigurableGlobDatasetFinder-org.apache.hadoop.fs.FileSystem-java.util.Properties-">ConfigurableGlobDatasetFinder</a></span>(<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="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;props)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#ConfigurableGlobDatasetFinder-org.apache.hadoop.fs.FileSystem-java.util.Properties-com.typesafe.config.Config-">ConfigurableGlobDatasetFinder</a></span>(<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="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://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>&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><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><a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#commonDatasetRoot--">commonDatasetRoot</a></span>()</code>
<div class="block">Returns the deepest non-glob ancestor of the dataset pattern.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#datasetAtPath-org.apache.hadoop.fs.Path-">datasetAtPath</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path)</code>
<div class="block">Creates a <a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a> from a path.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#findDatasets--">findDatasets</a></span>()</code>
<div class="block">Finds all directories satisfying the input glob pattern, and creates a <a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a>
for each one using <a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#datasetAtPath-org.apache.hadoop.fs.Path-"><code>datasetAtPath(org.apache.hadoop.fs.Path)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#getDatasetDirs--">getDatasetDirs</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#requiredProperties--">requiredProperties</a></span>()</code>
<div class="block">List of required properties for subclasses of this dataset.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DATASET_PATTERN_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATASET_PATTERN_KEY</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static final&nbsp;<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> DATASET_PATTERN_KEY</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#gobblin.data.management.retention.profile.ConfigurableGlobDatasetFinder.DATASET_PATTERN_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATASET_BLACKLIST_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATASET_BLACKLIST_KEY</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static final&nbsp;<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> DATASET_BLACKLIST_KEY</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#gobblin.data.management.retention.profile.ConfigurableGlobDatasetFinder.DATASET_BLACKLIST_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATASET_FINDER_PATTERN_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATASET_FINDER_PATTERN_KEY</h4>
<pre>public static final&nbsp;<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> DATASET_FINDER_PATTERN_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#gobblin.data.management.retention.profile.ConfigurableGlobDatasetFinder.DATASET_FINDER_PATTERN_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATASET_FINDER_BLACKLIST_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATASET_FINDER_BLACKLIST_KEY</h4>
<pre>public static final&nbsp;<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> DATASET_FINDER_BLACKLIST_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#gobblin.data.management.retention.profile.ConfigurableGlobDatasetFinder.DATASET_FINDER_BLACKLIST_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="datasetPattern">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>datasetPattern</h4>
<pre>protected final&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a> datasetPattern</pre>
</li>
</ul>
<a name="fs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fs</h4>
<pre>protected final&nbsp;<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> fs</pre>
</li>
</ul>
<a name="props">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>props</h4>
<pre>protected final&nbsp;<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> props</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConfigurableGlobDatasetFinder-org.apache.hadoop.fs.FileSystem-java.util.Properties-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConfigurableGlobDatasetFinder</h4>
<pre>public&nbsp;ConfigurableGlobDatasetFinder(<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="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://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>
</li>
</ul>
<a name="ConfigurableGlobDatasetFinder-org.apache.hadoop.fs.FileSystem-java.util.Properties-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigurableGlobDatasetFinder</h4>
<pre>public&nbsp;ConfigurableGlobDatasetFinder(<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="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;props)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="requiredProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredProperties</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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;requiredProperties()</pre>
<div class="block">List of required properties for subclasses of this dataset. The constructor will check that the input
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> contain all properties returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of all required property keys in the constructor <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a>.</dd>
</dl>
</li>
</ul>
<a name="findDatasets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findDatasets</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a>&gt;&nbsp;findDatasets()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Finds all directories satisfying the input glob pattern, and creates a <a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a>
for each one using <a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html#datasetAtPath-org.apache.hadoop.fs.Path-"><code>datasetAtPath(org.apache.hadoop.fs.Path)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true#findDatasets--" title="class or interface in gobblin.dataset">findDatasets</a></code>&nbsp;in interface&nbsp;<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true" title="class or interface in gobblin.dataset">DatasetsFinder</a>&lt;<a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a> extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/Dataset.html?is-external=true" title="class or interface in gobblin.dataset">Dataset</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of <a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a>s in the file system.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDatasetDirs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatasetDirs</h4>
<pre>protected&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>[]&nbsp;getDatasetDirs()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the directories that satisfy the input glob pattern.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="commonDatasetRoot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commonDatasetRoot</h4>
<pre>public&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;commonDatasetRoot()</pre>
<div class="block">Returns the deepest non-glob ancestor of the dataset pattern.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true#commonDatasetRoot--" title="class or interface in gobblin.dataset">commonDatasetRoot</a></code>&nbsp;in interface&nbsp;<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/DatasetsFinder.html?is-external=true" title="class or interface in gobblin.dataset">DatasetsFinder</a>&lt;<a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a> extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/dataset/Dataset.html?is-external=true" title="class or interface in gobblin.dataset">Dataset</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="datasetAtPath-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>datasetAtPath</h4>
<pre>public abstract&nbsp;<a href="../../../../../gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" title="type parameter in ConfigurableGlobDatasetFinder">T</a>&nbsp;datasetAtPath(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a <a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a> from a path. The default implementation
creates a <a href="../../../../../gobblin/data/management/retention/dataset/ConfigurableCleanableDataset.html" title="class in gobblin.data.management.retention.dataset"><code>ConfigurableCleanableDataset</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> where dataset is located.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../gobblin/data/management/retention/dataset/CleanableDataset.html" title="interface in gobblin.data.management.retention.dataset"><code>CleanableDataset</code></a> at that path.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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/data/management/retention/profile/ConfigBasedCleanabledDatasetFinder.html" title="class in gobblin.data.management.retention.profile"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../gobblin/data/management/retention/profile/GlobCleanableDatasetFinder.html" title="class in gobblin.data.management.retention.profile"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/data/management/retention/profile/ConfigurableGlobDatasetFinder.html" target="_top">Frames</a></li>
<li><a href="ConfigurableGlobDatasetFinder.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>