blob: 0de823e1d7463fb2f63adda41612136290e03421 [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:11:52 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TimelineDataToRetrieve (Apache Hadoop YARN Timeline Service 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="TimelineDataToRetrieve (Apache Hadoop YARN Timeline Service 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/TimelineDataToRetrieve.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineEntityFilters.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" target="_top">Frames</a></li>
<li><a href="TimelineDataToRetrieve.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">org.apache.hadoop.yarn.server.timelineservice.reader</div>
<h2 title="Class TimelineDataToRetrieve" class="title">Class TimelineDataToRetrieve</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>org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public class <span class="typeNameLabel">TimelineDataToRetrieve</span>
extends <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></pre>
<div class="block">Encapsulates information regarding which data to retrieve for each entity
while querying.<br>
Data to retrieve contains the following :<br>
<ul>
<li><b>confsToRetrieve</b> - Used for deciding which configs to return
in response. This is represented as a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter"><code>TimelineFilterList</code></a> object
containing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelinePrefixFilter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter"><code>TimelinePrefixFilter</code></a> objects. These can either be
exact config keys' or prefixes which are then compared against config
keys' to decide configs(inside entities) to return in response. If null
or empty, all configurations will be fetched if fieldsToRetrieve
contains <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html#CONFIGS"><code>TimelineReader.Field.CONFIGS</code></a> or <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html#ALL"><code>TimelineReader.Field.ALL</code></a>. This should not be
confused with configFilters which is used to decide which entities to
return instead.</li>
<li><b>metricsToRetrieve</b> - Used for deciding which metrics to return
in response. This is represented as a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter"><code>TimelineFilterList</code></a> object
containing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelinePrefixFilter.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter"><code>TimelinePrefixFilter</code></a> objects. These can either be
exact metric ids' or prefixes which are then compared against metric
ids' to decide metrics(inside entities) to return in response. If null
or empty, all metrics will be fetched if fieldsToRetrieve contains
<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html#METRICS"><code>TimelineReader.Field.METRICS</code></a> or <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html#ALL"><code>TimelineReader.Field.ALL</code></a>. This should not be confused
with metricFilters which is used to decide which entities to return
instead.</li>
<li><b>fieldsToRetrieve</b> - Specifies which fields of the entity
object to retrieve, see <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage"><code>TimelineReader.Field</code></a>. If null, retrieves 3 fields,
namely entity id, entity type and entity created time. All fields will
be returned if <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html#ALL"><code>TimelineReader.Field.ALL</code></a> is specified.</li>
<li><b>metricsLimit</b> - If fieldsToRetrieve contains METRICS/ALL or
metricsToRetrieve is specified, this limit defines an upper limit to the
number of metrics to return. This parameter is ignored if METRICS are not to
be fetched.</li>
<li><b>metricsTimeStart</b> - Metric values before this timestamp would not
be retrieved. If null or &lt;0, defaults to 0.</li>
<li><b>metricsTimeEnd</b> - Metric values after this timestamp would not
be retrieved. If null or &lt;0, defaults to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a>.
</li>
</ul></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/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#DEFAULT_METRICS_LIMIT">DEFAULT_METRICS_LIMIT</a></span></code>
<div class="block">Default limit of number of metrics to return.</div>
</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="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#TimelineDataToRetrieve--">TimelineDataToRetrieve</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#TimelineDataToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.EnumSet-java.lang.Integer-java.lang.Long-java.lang.Long-">TimelineDataToRetrieve</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;confs,
<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;metrics,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;&nbsp;fields,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;limitForMetrics,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;metricTimeBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;metricTimeEnd)</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#addFieldsBasedOnConfsAndMetricsToRetrieve--">addFieldsBasedOnConfsAndMetricsToRetrieve</a></span>()</code>
<div class="block">Adds configs and metrics fields to fieldsToRetrieve(if they are not
present) if confsToRetrieve and metricsToRetrieve are specified.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getConfsToRetrieve--">getConfsToRetrieve</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getFieldsToRetrieve--">getFieldsToRetrieve</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getMetricsLimit--">getMetricsLimit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getMetricsTimeBegin--">getMetricsTimeBegin</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getMetricsTimeEnd--">getMetricsTimeEnd</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#getMetricsToRetrieve--">getMetricsToRetrieve</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#setConfsToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-">setConfsToRetrieve</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;confs)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#setFieldsToRetrieve-java.util.EnumSet-">setFieldsToRetrieve</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;&nbsp;fields)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#setMetricsLimit-java.lang.Integer-">setMetricsLimit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;limit)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html#setMetricsToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-">setMetricsToRetrieve</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;metrics)</code>&nbsp;</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/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#toString--" title="class or interface in java.lang">toString</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_METRICS_LIMIT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_METRICS_LIMIT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> DEFAULT_METRICS_LIMIT</pre>
<div class="block">Default limit of number of metrics to return.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TimelineDataToRetrieve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TimelineDataToRetrieve</h4>
<pre>public&nbsp;TimelineDataToRetrieve()</pre>
</li>
</ul>
<a name="TimelineDataToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.EnumSet-java.lang.Integer-java.lang.Long-java.lang.Long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimelineDataToRetrieve</h4>
<pre>public&nbsp;TimelineDataToRetrieve(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;confs,
<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;metrics,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;&nbsp;fields,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;limitForMetrics,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;metricTimeBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;metricTimeEnd)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfsToRetrieve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfsToRetrieve</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;getConfsToRetrieve()</pre>
</li>
</ul>
<a name="setConfsToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfsToRetrieve</h4>
<pre>public&nbsp;void&nbsp;setConfsToRetrieve(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;confs)</pre>
</li>
</ul>
<a name="getMetricsToRetrieve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsToRetrieve</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;getMetricsToRetrieve()</pre>
</li>
</ul>
<a name="setMetricsToRetrieve-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsToRetrieve</h4>
<pre>public&nbsp;void&nbsp;setMetricsToRetrieve(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/filter/TimelineFilterList.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader.filter">TimelineFilterList</a>&nbsp;metrics)</pre>
</li>
</ul>
<a name="getFieldsToRetrieve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldsToRetrieve</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;&nbsp;getFieldsToRetrieve()</pre>
</li>
</ul>
<a name="setFieldsToRetrieve-java.util.EnumSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFieldsToRetrieve</h4>
<pre>public&nbsp;void&nbsp;setFieldsToRetrieve(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader.Field</a>&gt;&nbsp;fields)</pre>
</li>
</ul>
<a name="addFieldsBasedOnConfsAndMetricsToRetrieve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFieldsBasedOnConfsAndMetricsToRetrieve</h4>
<pre>public&nbsp;void&nbsp;addFieldsBasedOnConfsAndMetricsToRetrieve()</pre>
<div class="block">Adds configs and metrics fields to fieldsToRetrieve(if they are not
present) if confsToRetrieve and metricsToRetrieve are specified.</div>
</li>
</ul>
<a name="getMetricsLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsLimit</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getMetricsLimit()</pre>
</li>
</ul>
<a name="getMetricsTimeBegin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsTimeBegin</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;getMetricsTimeBegin()</pre>
</li>
</ul>
<a name="getMetricsTimeEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsTimeEnd</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;getMetricsTimeEnd()</pre>
</li>
</ul>
<a name="setMetricsLimit-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMetricsLimit</h4>
<pre>public&nbsp;void&nbsp;setMetricsLimit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;limit)</pre>
</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/TimelineDataToRetrieve.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineEntityFilters.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" target="_top">Frames</a></li>
<li><a href="TimelineDataToRetrieve.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 ======= -->
<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>