Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-timelineservice-hbase / hadoop-yarn-server-timelineservice-hbase-common / apidocs / org / apache / hadoop / yarn / server / timelineservice / storage / flow / FlowRunRowKeyPrefix.html
blob: 5ba7d4ed83f5509b0dac064f5d3df577779b695f [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>FlowRunRowKeyPrefix (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="FlowRunRowKeyPrefix (Apache Hadoop YARN TimelineService HBase Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="class-use/FlowRunRowKeyPrefix.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/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKeyPrefix.html" target="_top">Frames</a></li>
<li><a href="FlowRunRowKeyPrefix.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><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>Field&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">org.apache.hadoop.yarn.server.timelineservice.storage.flow</div>
<h2 title="Class FlowRunRowKeyPrefix" class="title">Class FlowRunRowKeyPrefix</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowRunRowKey</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowRunRowKeyPrefix</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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;<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunRowKey</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FlowRunRowKeyPrefix</span>
extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunRowKey</a>
implements <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;<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunRowKey</a>&gt;</pre>
<div class="block">Represents a partial rowkey (without the flowRunId) for the flow run table.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKeyPrefix.html#FlowRunRowKeyPrefix-java.lang.String-java.lang.String-java.lang.String-">FlowRunRowKeyPrefix</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clusterId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;flowName)</code>
<div class="block">Constructs a row key prefix for the flow run table as follows:
<code>clusterId!userI!flowName!</code>.</div>
</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="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>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKeyPrefix.html#getRowKeyPrefix--">getRowKeyPrefix</a></span>()</code>
<div class="block">Create a row key prefix, meaning a partial rowkey that can be used in range
scans.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowRunRowKey">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.yarn.server.timelineservice.storage.flow.<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunRowKey</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getClusterId--">getClusterId</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getFlowName--">getFlowName</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getFlowRunId--">getFlowRunId</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getRowKey--">getRowKey</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getRowKeyAsString--">getRowKeyAsString</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#getUserId--">getUserId</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#parseRowKey-byte:A-">parseRowKey</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#parseRowKeyFromString-java.lang.String-">parseRowKeyFromString</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html#toString--">toString</a></code></li>
</ul>
<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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FlowRunRowKeyPrefix-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FlowRunRowKeyPrefix</h4>
<pre>public&nbsp;FlowRunRowKeyPrefix(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clusterId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;flowName)</pre>
<div class="block">Constructs a row key prefix for the flow run table as follows:
<code>clusterId!userI!flowName!</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterId</code> - identifying the cluster</dd>
<dd><code>userId</code> - identifying the user</dd>
<dd><code>flowName</code> - identifying the flow</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRowKeyPrefix--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRowKeyPrefix</h4>
<pre>public&nbsp;byte[]&nbsp;getRowKeyPrefix()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/RowKeyPrefix.html#getRowKeyPrefix--">RowKeyPrefix</a></code></span></div>
<div class="block">Create a row key prefix, meaning a partial rowkey that can be used in range
scans. Which fields are included in the prefix will depend on the
constructor of the specific instance that was used. Output depends on which
constructor was used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/RowKeyPrefix.html#getRowKeyPrefix--">getRowKeyPrefix</a></code>&nbsp;in interface&nbsp;<code><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;<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunRowKey</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a prefix of the following form <code>fist!second!...!last!</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="class-use/FlowRunRowKeyPrefix.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/flow/FlowRunRowKey.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunRowKeyPrefix.html" target="_top">Frames</a></li>
<li><a href="FlowRunRowKeyPrefix.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><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>Field&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 ======= -->
<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>