blob: e4221e6745d10e503caad796ba8ca1f11ae6903b [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_201) on Thu Apr 11 20:05:13 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RFile.ScannerFSOptions (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<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="RFile.ScannerFSOptions (Apache Accumulo Project 1.9.3 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="class-use/RFile.ScannerFSOptions.html">Use</a></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="../../../../../../org/apache/accumulo/core/client/rfile/RFile.OutputArguments.html" title="interface in org.apache.accumulo.core.client.rfile"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/rfile/RFile.ScannerFSOptions.html" target="_top">Frames</a></li>
<li><a href="RFile.ScannerFSOptions.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">org.apache.accumulo.core.client.rfile</div>
<h2 title="Interface RFile.ScannerFSOptions" class="title">Interface RFile.ScannerFSOptions</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile">RFile.ScannerOptions</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.html" title="class in org.apache.accumulo.core.client.rfile">RFile</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">RFile.ScannerFSOptions</span>
extends <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile">RFile.ScannerOptions</a></pre>
<div class="block">This is an intermediate interface in a larger builder pattern. Enables optionally setting a
FileSystem to read RFile(s) from.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8.0</dd>
</dl>
</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><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile">RFile.ScannerOptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerFSOptions.html#withFileSystem-org.apache.hadoop.fs.FileSystem-">withFileSystem</a></span>(org.apache.hadoop.fs.FileSystem&nbsp;fs)</code>
<div class="block">Optionally provide a FileSystem to open RFiles.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.accumulo.core.client.rfile.RFile.ScannerOptions">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.accumulo.core.client.rfile.<a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile">RFile.ScannerOptions</a></h3>
<code><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#build--">build</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withAuthorizations-org.apache.accumulo.core.security.Authorizations-">withAuthorizations</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withBounds-org.apache.accumulo.core.data.Range-">withBounds</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withDataCache-long-">withDataCache</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withIndexCache-long-">withIndexCache</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withoutSystemIterators--">withoutSystemIterators</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withTableProperties-java.lang.Iterable-">withTableProperties</a>, <a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html#withTableProperties-java.util.Map-">withTableProperties</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="withFileSystem-org.apache.hadoop.fs.FileSystem-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withFileSystem</h4>
<pre><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile">RFile.ScannerOptions</a>&nbsp;withFileSystem(org.apache.hadoop.fs.FileSystem&nbsp;fs)</pre>
<div class="block">Optionally provide a FileSystem to open RFiles. If not specified, the FileSystem will be
constructed using configuration on the classpath.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fs</code> - use this FileSystem to open files.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</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="class-use/RFile.ScannerFSOptions.html">Use</a></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="../../../../../../org/apache/accumulo/core/client/rfile/RFile.OutputArguments.html" title="interface in org.apache.accumulo.core.client.rfile"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/rfile/RFile.ScannerOptions.html" title="interface in org.apache.accumulo.core.client.rfile"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/rfile/RFile.ScannerFSOptions.html" target="_top">Frames</a></li>
<li><a href="RFile.ScannerFSOptions.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>