Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-api / apidocs / org / apache / hadoop / yarn / util / resource / ResourceUtils.html
blob: d3c705cf71851ae305b961a23ec43cd655a0d843 [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:09:33 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ResourceUtils (Apache Hadoop YARN API 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="ResourceUtils (Apache Hadoop YARN API 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ResourceUtils.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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/util/resource/ResourceUtils.html" target="_top">Frames</a></li>
<li><a href="ResourceUtils.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>Constr&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>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.hadoop.yarn.util.resource</div>
<h2 title="Class ResourceUtils" class="title">Class ResourceUtils</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.util.resource.ResourceUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ResourceUtils</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">Helper class to read the resource-types to be supported by the system.</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/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#EXTERNAL_VOLUME_RESOURCE_TAG">EXTERNAL_VOLUME_RESOURCE_TAG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#MAXIMUM_ALLOCATION">MAXIMUM_ALLOCATION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#MINIMUM_ALLOCATION">MINIMUM_ALLOCATION</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#RESOURCE_REQUEST_VALUE_PATTERN">RESOURCE_REQUEST_VALUE_PATTERN</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#TAGS">TAGS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#TYPE">TYPE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#UNITS">UNITS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#YARN_IO_OPTIONAL">YARN_IO_OPTIONAL</a></span></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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#areMandatoryResourcesAvailable-org.apache.hadoop.yarn.api.records.Resource-">areMandatoryResourcesAvailable</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;res)</code>
<div class="block">Are mandatory resources like memory-mb, vcores available?
If not, throw exceptions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#createResourceFromString-java.lang.String-java.util.List-">createResourceFromString</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;resourceStr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;&nbsp;resourceTypeInfos)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#createResourceTypesArray-java.util.Map-">createResourceTypesArray</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;res)</code>
<div class="block">Create an array of <a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records"><code>ResourceInformation</code></a> objects corresponding to
the passed in map of names to values.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#createResourceWithSameValue-long-">createResourceWithSameValue</a></span>(long&nbsp;value)</code>
<div class="block">Return a new <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> instance with all resource values
initialized to <code>value</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#fetchMaximumAllocationFromConfig-org.apache.hadoop.conf.Configuration-">fetchMaximumAllocationFromConfig</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Get maximum allocation from config, *THIS WILL NOT UPDATE INTERNAL DATA*</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getCustomResourcesStrings-org.apache.hadoop.yarn.api.records.Resource-">getCustomResourcesStrings</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;resource)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getDefaultUnit-java.lang.String-">getDefaultUnit</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;resourceType)</code>
<div class="block">Get default unit by given resource type.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getNodeResourceInformation-org.apache.hadoop.conf.Configuration-">getNodeResourceInformation</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Function to get the resources for a node.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getNumberOfCountableResourceTypes--">getNumberOfCountableResourceTypes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getNumberOfKnownResourceTypes--">getNumberOfKnownResourceTypes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getRequestedResourcesFromConfig-org.apache.hadoop.conf.Configuration-java.lang.String-">getRequestedResourcesFromConfig</a></span>(org.apache.hadoop.conf.Configuration&nbsp;configuration,
<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;prefix)</code>
<div class="block">From a given configuration get all entries representing requested
resources: entries that match the {prefix}{resourceName}={value}[{units}]
pattern.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourcesTypeInfo--">getResourcesTypeInfo</a></span>()</code>
<div class="block">Get all resource types information from known resource types.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypeIndex--">getResourceTypeIndex</a></span>()</code>
<div class="block">Get associate index of resource types such memory, cpu etc.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypes--">getResourceTypes</a></span>()</code>
<div class="block">Get the resource types to be supported by the system.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypesArray--">getResourceTypesArray</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypesMaximumAllocation--">getResourceTypesMaximumAllocation</a></span>()</code>
<div class="block">Get a Resource object with for the maximum allocation possible.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypesMinimumAllocation--">getResourceTypesMinimumAllocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getUnits-java.lang.String-">getUnits</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;resourceValue)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getValue-java.lang.String-">getValue</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;resourceValue)</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#initializeResourcesFromResourceInformationMap-java.util.Map-">initializeResourcesFromResourceInformationMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;resourceInformationMap)</code>
<div class="block">This method is visible for testing, unit test can construct a
resourceInformationMap and pass it to this method to initialize multiple resources.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static <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>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#parseResourceValue-java.lang.String-">parseResourceValue</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;resourceValue)</code>
<div class="block">Extract unit and actual value from resource value.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#reinitializeResources-java.util.List-">reinitializeResources</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;&nbsp;resourceTypeInfo)</code>
<div class="block">Reinitialize all resource types from external source (in case of client,
server will send the updated list and local resourceutils cache will be
updated as per server's list of resources)</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#resetNodeResources--">resetNodeResources</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#resetResourceTypes--">resetResourceTypes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#resetResourceTypes-org.apache.hadoop.conf.Configuration-">resetResourceTypes</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</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="UNITS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNITS</h4>
<pre>public static final&nbsp;<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> UNITS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.UNITS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE</h4>
<pre>public static final&nbsp;<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> TYPE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAGS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAGS</h4>
<pre>public static final&nbsp;<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> TAGS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.TAGS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MINIMUM_ALLOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MINIMUM_ALLOCATION</h4>
<pre>public static final&nbsp;<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> MINIMUM_ALLOCATION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.MINIMUM_ALLOCATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAXIMUM_ALLOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAXIMUM_ALLOCATION</h4>
<pre>public static final&nbsp;<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> MAXIMUM_ALLOCATION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.MAXIMUM_ALLOCATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXTERNAL_VOLUME_RESOURCE_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXTERNAL_VOLUME_RESOURCE_TAG</h4>
<pre>public static final&nbsp;<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> EXTERNAL_VOLUME_RESOURCE_TAG</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.EXTERNAL_VOLUME_RESOURCE_TAG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RESOURCE_REQUEST_VALUE_PATTERN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RESOURCE_REQUEST_VALUE_PATTERN</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> RESOURCE_REQUEST_VALUE_PATTERN</pre>
</li>
</ul>
<a name="YARN_IO_OPTIONAL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>YARN_IO_OPTIONAL</h4>
<pre>public static final&nbsp;<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> YARN_IO_OPTIONAL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.util.resource.ResourceUtils.YARN_IO_OPTIONAL">Constant Field Values</a></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="fetchMaximumAllocationFromConfig-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchMaximumAllocationFromConfig</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;fetchMaximumAllocationFromConfig(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Get maximum allocation from config, *THIS WILL NOT UPDATE INTERNAL DATA*</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - config</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum allocation</dd>
</dl>
</li>
</ul>
<a name="initializeResourcesFromResourceInformationMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeResourcesFromResourceInformationMap</h4>
<pre>public static&nbsp;void&nbsp;initializeResourcesFromResourceInformationMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;resourceInformationMap)</pre>
<div class="block">This method is visible for testing, unit test can construct a
resourceInformationMap and pass it to this method to initialize multiple resources.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourceInformationMap</code> - constructed resource information map.</dd>
</dl>
</li>
</ul>
<a name="getResourceTypeIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceTypeIndex</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;getResourceTypeIndex()</pre>
<div class="block">Get associate index of resource types such memory, cpu etc.
This could help to access each resource types in a resource faster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Index map for all Resource Types.</dd>
</dl>
</li>
</ul>
<a name="getResourceTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceTypes</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;getResourceTypes()</pre>
<div class="block">Get the resource types to be supported by the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A map of the resource name to a ResouceInformation object
which contains details such as the unit.</dd>
</dl>
</li>
</ul>
<a name="getResourceTypesArray--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceTypesArray</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>[]&nbsp;getResourceTypesArray()</pre>
</li>
</ul>
<a name="getNumberOfKnownResourceTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfKnownResourceTypes</h4>
<pre>public static&nbsp;int&nbsp;getNumberOfKnownResourceTypes()</pre>
</li>
</ul>
<a name="getNumberOfCountableResourceTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfCountableResourceTypes</h4>
<pre>public static&nbsp;int&nbsp;getNumberOfCountableResourceTypes()</pre>
</li>
</ul>
<a name="resetResourceTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetResourceTypes</h4>
<pre>public static&nbsp;void&nbsp;resetResourceTypes()</pre>
</li>
</ul>
<a name="resetResourceTypes-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetResourceTypes</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;resetResourceTypes(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a name="getUnits-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnits</h4>
<pre>public static&nbsp;<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;getUnits(<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;resourceValue)</pre>
</li>
</ul>
<a name="parseResourceValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseResourceValue</h4>
<pre>public static&nbsp;<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;parseResourceValue(<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;resourceValue)</pre>
<div class="block">Extract unit and actual value from resource value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourceValue</code> - Value of the resource</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array containing unit and value. [0]=unit, [1]=value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if units contain non alpha characters</dd>
</dl>
</li>
</ul>
<a name="getValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public static&nbsp;long&nbsp;getValue(<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;resourceValue)</pre>
</li>
</ul>
<a name="getNodeResourceInformation-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeResourceInformation</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;getNodeResourceInformation(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Function to get the resources for a node. This function will look at the
file <a href="../../../../../../org/apache/hadoop/yarn/conf/YarnConfiguration.html#NODE_RESOURCES_CONFIGURATION_FILE"><code>YarnConfiguration.NODE_RESOURCES_CONFIGURATION_FILE</code></a> to
determine the node resources.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - configuration file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map to resource name to the ResourceInformation object. The map
is guaranteed to have entries for memory and vcores</dd>
</dl>
</li>
</ul>
<a name="resetNodeResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetNodeResources</h4>
<pre>public static&nbsp;void&nbsp;resetNodeResources()</pre>
</li>
</ul>
<a name="getResourceTypesMinimumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceTypesMinimumAllocation</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;getResourceTypesMinimumAllocation()</pre>
</li>
</ul>
<a name="getResourceTypesMaximumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceTypesMaximumAllocation</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;getResourceTypesMaximumAllocation()</pre>
<div class="block">Get a Resource object with for the maximum allocation possible.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Resource object with the maximum allocation for the scheduler</dd>
</dl>
</li>
</ul>
<a name="getDefaultUnit-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultUnit</h4>
<pre>public static&nbsp;<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;getDefaultUnit(<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;resourceType)</pre>
<div class="block">Get default unit by given resource type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourceType</code> - resourceType</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default unit</dd>
</dl>
</li>
</ul>
<a name="getResourcesTypeInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourcesTypeInfo</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;&nbsp;getResourcesTypeInfo()</pre>
<div class="block">Get all resource types information from known resource types.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of ResourceTypeInfo</dd>
</dl>
</li>
</ul>
<a name="reinitializeResources-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reinitializeResources</h4>
<pre>public static&nbsp;void&nbsp;reinitializeResources(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;&nbsp;resourceTypeInfo)</pre>
<div class="block">Reinitialize all resource types from external source (in case of client,
server will send the updated list and local resourceutils cache will be
updated as per server's list of resources)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourceTypeInfo</code> - List of resource types</dd>
</dl>
</li>
</ul>
<a name="getRequestedResourcesFromConfig-org.apache.hadoop.conf.Configuration-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestedResourcesFromConfig</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>&gt;&nbsp;getRequestedResourcesFromConfig(org.apache.hadoop.conf.Configuration&nbsp;configuration,
<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;prefix)</pre>
<div class="block">From a given configuration get all entries representing requested
resources: entries that match the {prefix}{resourceName}={value}[{units}]
pattern.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - The configuration</dd>
<dd><code>prefix</code> - Keys with this prefix are considered from the configuration</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of requested resources as described by the configuration</dd>
</dl>
</li>
</ul>
<a name="areMandatoryResourcesAvailable-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areMandatoryResourcesAvailable</h4>
<pre>public static&nbsp;void&nbsp;areMandatoryResourcesAvailable(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;res)</pre>
<div class="block">Are mandatory resources like memory-mb, vcores available?
If not, throw exceptions. On availability, ensure those values are
within boundary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>res</code> - resource</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if mandatory resource is not available or
value is not within boundary</dd>
</dl>
</li>
</ul>
<a name="createResourceTypesArray-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResourceTypesArray</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records">ResourceInformation</a>[]&nbsp;createResourceTypesArray(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;res)</pre>
<div class="block">Create an array of <a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records"><code>ResourceInformation</code></a> objects corresponding to
the passed in map of names to values. The array will be ordered according
to the order returned by <a href="../../../../../../org/apache/hadoop/yarn/util/resource/ResourceUtils.html#getResourceTypesArray--"><code>getResourceTypesArray()</code></a>. The value of
each resource type in the returned array will either be the value given for
that resource in the <code>res</code> parameter or, if none is given, 0.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>res</code> - the map of resource type values</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of <a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceInformation.html" title="class in org.apache.hadoop.yarn.api.records"><code>ResourceInformation</code></a> instances</dd>
</dl>
</li>
</ul>
<a name="createResourceWithSameValue-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResourceWithSameValue</h4>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;createResourceWithSameValue(long&nbsp;value)</pre>
<div class="block">Return a new <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> instance with all resource values
initialized to <code>value</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value to use for all resources</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="createResourceFromString-java.lang.String-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResourceFromString</h4>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;createResourceFromString(<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;resourceStr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/hadoop/yarn/api/records/ResourceTypeInfo.html" title="class in org.apache.hadoop.yarn.api.records">ResourceTypeInfo</a>&gt;&nbsp;resourceTypeInfos)</pre>
</li>
</ul>
<a name="getCustomResourcesStrings-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCustomResourcesStrings</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;getCustomResourcesStrings(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;resource)</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/ResourceUtils.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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/util/resource/ResourceUtils.html" target="_top">Frames</a></li>
<li><a href="ResourceUtils.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>Constr&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>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; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>