Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-project-dist / hadoop-hdfs-client / build / source / hadoop-hdfs-project / hadoop-hdfs-client / target / api / org / apache / hadoop / hdfs / protocol / package-summary.html
blob: 3dfbc71d9d335906a9cbe99e0f6b7c250501bedd [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_292) on Tue Jun 15 06:05:36 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.hdfs.protocol (Apache Hadoop HDFS Client 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="org.apache.hadoop.hdfs.protocol (Apache Hadoop HDFS Client 3.3.1 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/hadoop/hdfs/net/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/hadoop/hdfs/protocol/datatransfer/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hdfs/protocol/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.hdfs.protocol</h1>
<div class="docSummary">
<div class="block">Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/AddErasureCodingPolicyResponse.html" title="class in org.apache.hadoop.hdfs.protocol">AddErasureCodingPolicyResponse</a></td>
<td class="colLast">
<div class="block">A response of add an ErasureCoding policy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveEntry.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveEntry</a></td>
<td class="colLast">
<div class="block">Describes a path-based cache directive entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveInfo.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveInfo</a></td>
<td class="colLast">
<div class="block">Describes a path-based cache directive.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveInfo.Builder.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveInfo.Builder</a></td>
<td class="colLast">
<div class="block">A builder for creating new CacheDirectiveInfo instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveInfo.Expiration.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveInfo.Expiration</a></td>
<td class="colLast">
<div class="block">Denotes a relative or absolute expiration time for a CacheDirective.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveStats.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveStats</a></td>
<td class="colLast">
<div class="block">Describes a path-based cache directive.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CacheDirectiveStats.Builder.html" title="class in org.apache.hadoop.hdfs.protocol">CacheDirectiveStats.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CachePoolEntry.html" title="class in org.apache.hadoop.hdfs.protocol">CachePoolEntry</a></td>
<td class="colLast">
<div class="block">Describes a Cache Pool entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CachePoolInfo.html" title="class in org.apache.hadoop.hdfs.protocol">CachePoolInfo</a></td>
<td class="colLast">
<div class="block">CachePoolInfo describes a cache pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CachePoolStats.html" title="class in org.apache.hadoop.hdfs.protocol">CachePoolStats</a></td>
<td class="colLast">
<div class="block">CachePoolStats describes cache pool statistics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CachePoolStats.Builder.html" title="class in org.apache.hadoop.hdfs.protocol">CachePoolStats.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/CorruptFileBlocks.html" title="class in org.apache.hadoop.hdfs.protocol">CorruptFileBlocks</a></td>
<td class="colLast">
<div class="block">Contains a list of paths corresponding to corrupt files and a cookie
used for iterative calls to NameNode.listCorruptFileBlocks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/DatanodeAdminProperties.html" title="class in org.apache.hadoop.hdfs.protocol">DatanodeAdminProperties</a></td>
<td class="colLast">
<div class="block">The class describes the configured admin properties for a datanode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/DatanodeInfo.DatanodeInfoBuilder.html" title="class in org.apache.hadoop.hdfs.protocol">DatanodeInfo.DatanodeInfoBuilder</a></td>
<td class="colLast">
<div class="block">Building the DataNodeInfo.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/ECBlockGroupStats.html" title="class in org.apache.hadoop.hdfs.protocol">ECBlockGroupStats</a></td>
<td class="colLast">
<div class="block">Get statistics pertaining to blocks of type <a href="../../../../../org/apache/hadoop/hdfs/protocol/BlockType.html#STRIPED"><code>BlockType.STRIPED</code></a>
in the filesystem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/EncryptionZone.html" title="class in org.apache.hadoop.hdfs.protocol">EncryptionZone</a></td>
<td class="colLast">
<div class="block">A simple class for representing an encryption zone.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsNamedFileStatus.html" title="class in org.apache.hadoop.hdfs.protocol">HdfsNamedFileStatus</a></td>
<td class="colLast">
<div class="block">HDFS metadata for an entity in the filesystem without locations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/ReplicatedBlockStats.html" title="class in org.apache.hadoop.hdfs.protocol">ReplicatedBlockStats</a></td>
<td class="colLast">
<div class="block">Get statistics pertaining to blocks of type <a href="../../../../../org/apache/hadoop/hdfs/protocol/BlockType.html#CONTIGUOUS"><code>BlockType.CONTIGUOUS</code></a>
in the filesystem.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/RollingUpgradeInfo.Bean.html" title="class in org.apache.hadoop.hdfs.protocol">RollingUpgradeInfo.Bean</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReport.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotDiffReport</a></td>
<td class="colLast">
<div class="block">This class represents to end users the difference between two snapshots of
the same directory, or the difference between a snapshot of the directory and
its current state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReport.DiffReportEntry.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotDiffReport.DiffReportEntry</a></td>
<td class="colLast">
<div class="block">Representing the full path and diff type of a file/directory where changes
have happened.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReport.DiffStats.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotDiffReport.DiffStats</a></td>
<td class="colLast">
<div class="block">Records the stats related to Snapshot diff operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReportListing.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotDiffReportListing</a></td>
<td class="colLast">
<div class="block">This class represents to the difference between two snapshots of
the same directory, or the difference between a snapshot of the directory and
its current state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReportListing.DiffReportListingEntry.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotDiffReportListing.DiffReportListingEntry</a></td>
<td class="colLast">
<div class="block">Representing the full path and diff type of a file/directory where changes
have happened.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshottableDirectoryStatus.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshottableDirectoryStatus</a></td>
<td class="colLast">
<div class="block">Metadata about a snapshottable directory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshottableDirectoryStatus.Bean.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshottableDirectoryStatus.Bean</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/ZoneReencryptionStatus.html" title="class in org.apache.hadoop.hdfs.protocol">ZoneReencryptionStatus</a></td>
<td class="colLast">
<div class="block">A class representing information about re-encryption of an encryption zone.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/ZoneReencryptionStatus.Builder.html" title="class in org.apache.hadoop.hdfs.protocol">ZoneReencryptionStatus.Builder</a></td>
<td class="colLast">
<div class="block">Builder of <a href="../../../../../org/apache/hadoop/hdfs/protocol/ZoneReencryptionStatus.html" title="class in org.apache.hadoop.hdfs.protocol"><code>ZoneReencryptionStatus</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/BlockType.html" title="enum in org.apache.hadoop.hdfs.protocol">BlockType</a></td>
<td class="colLast">
<div class="block">Type of a block.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/DatanodeInfo.AdminStates.html" title="enum in org.apache.hadoop.hdfs.protocol">DatanodeInfo.AdminStates</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.DatanodeReportType.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.DatanodeReportType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.ReencryptAction.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.ReencryptAction</a></td>
<td class="colLast">
<div class="block">Re-encrypt encryption zone actions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.RollingUpgradeAction.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.RollingUpgradeAction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.SafeModeAction.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.SafeModeAction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.StoragePolicySatisfierMode.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.StoragePolicySatisfierMode</a></td>
<td class="colLast">
<div class="block">Storage policy satisfier service modes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsConstants.UpgradeAction.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsConstants.UpgradeAction</a></td>
<td class="colLast">
<div class="block">Upgrade actions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/HdfsFileStatus.Flags.html" title="enum in org.apache.hadoop.hdfs.protocol">HdfsFileStatus.Flags</a></td>
<td class="colLast">
<div class="block">Set of features potentially active on an instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/OpenFilesIterator.OpenFilesType.html" title="enum in org.apache.hadoop.hdfs.protocol">OpenFilesIterator.OpenFilesType</a></td>
<td class="colLast">
<div class="block">Open file types to filter the results.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotDiffReport.DiffType.html" title="enum in org.apache.hadoop.hdfs.protocol">SnapshotDiffReport.DiffType</a></td>
<td class="colLast">
<div class="block">Types of the difference, which include CREATE, MODIFY, DELETE, and RENAME.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/ZoneReencryptionStatus.State.html" title="enum in org.apache.hadoop.hdfs.protocol">ZoneReencryptionStatus.State</a></td>
<td class="colLast">
<div class="block">State of re-encryption.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/hadoop/hdfs/protocol/SnapshotAccessControlException.html" title="class in org.apache.hadoop.hdfs.protocol">SnapshotAccessControlException</a></td>
<td class="colLast">
<div class="block">Snapshot access related exception.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.hdfs.protocol Description">Package org.apache.hadoop.hdfs.protocol Description</h2>
<div class="block">Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/hadoop/hdfs/net/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/hadoop/hdfs/protocol/datatransfer/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hdfs/protocol/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>