blob: 52c08b5281e3e067f9755566adab7978b8da9c3f [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:13:00 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.yarn.server.timelineservice.storage.common (Apache Hadoop YARN TimelineService HBase Common 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.yarn.server.timelineservice.storage.common (Apache Hadoop YARN TimelineService HBase Common 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/yarn/server/timelineservice/storage/apptoflow/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/domain/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/common/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">
<p>@InterfaceAudience.Private
@InterfaceStability.Unstable
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.server.timelineservice.storage.common</h1>
<div class="docSummary">
<div class="block">Package org.apache.hadoop.yarn.server.timelineservice.storage.common contains
a set of utility classes used across backend storage reader and writer.</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="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/Column.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">Column</a>&lt;T extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a>&lt;T&gt;&gt;</td>
<td class="colLast">
<div class="block">A Column represents the way to store a fully qualified column in a specific
table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnFamily.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">ColumnFamily</a>&lt;T extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a>&lt;T&gt;&gt;</td>
<td class="colLast">
<div class="block">Type safe column family.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">ColumnPrefix</a>&lt;T extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a>&lt;T&gt;&gt;</td>
<td class="colLast">
<div class="block">Used to represent a partially qualified column, where the actual column name
will be composed of a prefix and the remainder of the column qualifier.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/KeyConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">KeyConverter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Interface which has to be implemented for encoding and decoding row keys and
columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/KeyConverterToString.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">KeyConverterToString</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Interface which has to be implemented for encoding and decoding row keys or
column qualifiers as string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/NumericValueConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">NumericValueConverter</a></td>
<td class="colLast">
<div class="block">Extends ValueConverter interface for numeric converters to support numerical
operations such as comparison, addition, etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/RowKeyPrefix.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">RowKeyPrefix</a>&lt;R&gt;</td>
<td class="colLast">
<div class="block">In queries where a single result is needed, an exact rowkey can be used
through the corresponding rowkey#getRowKey() method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ValueConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">ValueConverter</a></td>
<td class="colLast">
<div class="block">Converter used to encode/decode value associated with a column prefix or a
column.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/yarn/server/timelineservice/storage/common/AppIdKeyConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">AppIdKeyConverter</a></td>
<td class="colLast">
<div class="block">Encodes and decodes <code>ApplicationId</code> for row keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The base type of tables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnHelper.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">ColumnHelper</a></td>
<td class="colLast">
<div class="block">This class is meant to be used only by explicit Columns, and not directly to
write by clients.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/EventColumnName.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">EventColumnName</a></td>
<td class="colLast">
<div class="block">Encapsulates information about Event column names for application and entity
tables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/EventColumnNameConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">EventColumnNameConverter</a></td>
<td class="colLast">
<div class="block">Encodes and decodes event column names for application and entity tables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/GenericConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">GenericConverter</a></td>
<td class="colLast">
<div class="block">Uses GenericObjectMapper to encode objects as bytes and decode bytes as
objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/HBaseTimelineSchemaUtils.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">HBaseTimelineSchemaUtils</a></td>
<td class="colLast">
<div class="block">A bunch of utility functions used in HBase TimelineService common module.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/LongConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">LongConverter</a></td>
<td class="colLast">
<div class="block">Encodes a value by interpreting it as a Long and converting it to bytes and
decodes a set of bytes as a Long.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/LongKeyConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">LongKeyConverter</a></td>
<td class="colLast">
<div class="block">Encodes and decodes column names / row keys which are long.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/Range.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">Range</a></td>
<td class="colLast">
<div class="block">Encapsulates a range with start and end indices.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/StringKeyConverter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">StringKeyConverter</a></td>
<td class="colLast">
<div class="block">Encodes and decodes column names / row keys which are merely strings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/TimestampGenerator.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">TimestampGenerator</a></td>
<td class="colLast">
<div class="block">Utility class that allows HBase coprocessors to interact with unique
timestamps.</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/yarn/server/timelineservice/storage/common/Separator.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.common">Separator</a></td>
<td class="colLast">
<div class="block">Used to separate row qualifiers, column qualifiers and compound fields.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.yarn.server.timelineservice.storage.common Description">Package org.apache.hadoop.yarn.server.timelineservice.storage.common Description</h2>
<div class="block">Package org.apache.hadoop.yarn.server.timelineservice.storage.common contains
a set of utility classes used across backend storage reader and writer.</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/yarn/server/timelineservice/storage/apptoflow/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/domain/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/common/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>