Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-api / jdiff / xml / changes / org.apache.hadoop.yarn.api.records.Resource.html
blob: d3b76de50ae5cc6695826f01467390fed8efe588 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<HTML>
<HEAD>
<meta name="generator" content="JDiff v1.0.9">
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<meta name="description" content="JDiff is a Javadoc doclet which generates an HTML report of all the packages, classes, constructors, methods, and fields which have been removed, added or changed in any way, including their documentation, when two APIs are compared.">
<meta name="keywords" content="diff, jdiff, javadiff, java diff, java difference, API difference, difference between two APIs, API diff, Javadoc, doclet">
<TITLE>
org.apache.hadoop.yarn.api.records.Resource
</TITLE>
<LINK REL="stylesheet" TYPE="text/css" HREF="../stylesheet-jdiff.css" TITLE="Style">
</HEAD>
<BODY>
<!-- Start of nav bar -->
<TABLE summary="Navigation bar" BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<TABLE summary="Navigation bar" BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html" target="_top"><FONT CLASS="NavBarFont1"><B><tt>Apache Hadoop YARN API 3.3.1</tt></B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="changes-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="pkg_org.apache.hadoop.yarn.api.records.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="jdiff_statistics.html"><FONT CLASS="NavBarFont1"><B>Statistics</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="jdiff_help.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM><b>Generated by<br><a href="http://www.jdiff.org" class="staysblack" target="_top">JDiff</a></b></EM></TD>
</TR>
<TR>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.ReservationDefinition.html"><B>PREV CLASS</B></A>
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.ResourceOption.html"><B>NEXT CLASS</B></A>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<A HREF="../changes.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.Resource.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: &nbsp;
CONSTRUCTORS&nbsp;|&nbsp;
<a href="#methods">METHODS</a>&nbsp;|&nbsp;
<a href="#fields">FIELDS</a>
</FONT></TD>
</TR>
</TABLE>
<HR>
<!-- End of nav bar -->
<H2>
Class org.apache.hadoop.yarn.api.records.<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html" target="_top"><tt>Resource</tt></A>
</H2>
<a NAME="constructors"></a>
<a NAME="methods"></a>
<p>
<a NAME="Added"></a>
<TABLE summary="Added Methods" BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD VALIGN="TOP" COLSPAN=2><FONT SIZE="+1"><B>Added Methods</B></FONT></TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.castToIntSafely_added(long)"></A>
<nobr><code>int</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#castToIntSafely(long)" target="_top"><tt>castToIntSafely</tt></A>(<code>long</code>)</nobr>
</TD>
<TD VALIGN="TOP">Convert long to int for a resource value safely.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.compareTo_added(org.apache.hadoop.yarn.api.records.Resource)"></A>
<nobr><code>int</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#compareTo(org.apache.hadoop.yarn.api.records.Resource)" target="_top"><tt>compareTo</tt></A>(<code>Resource</code>)</nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.getFormattedString_added()"></A>
<nobr><code>String</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#getFormattedString()" target="_top"><tt>getFormattedString</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP">This method is to get memory in terms of KB|MB|GB.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.getMemorySize_added()"></A>
<nobr><code>long</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#getMemorySize()" target="_top"><tt>getMemorySize</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP">Get <em>memory</em> of the resource.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.getResourceInformation_added(java.lang.String)"></A>
<nobr><code>ResourceInformation</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#getResourceInformation(java.lang.String)" target="_top"><tt>getResourceInformation</tt></A>(<code>String</code>)</nobr>
</TD>
<TD VALIGN="TOP">Get ResourceInformation for a specified resource.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.getResourceValue_added(java.lang.String)"></A>
<nobr><code>long</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#getResourceValue(java.lang.String)" target="_top"><tt>getResourceValue</tt></A>(<code>String</code>)</nobr>
</TD>
<TD VALIGN="TOP">Get the value for a specified resource.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.newDefaultInformation_added(java.lang.String, java.lang.String, long)"></A>
<nobr><code>ResourceInformation</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#newDefaultInformation(java.lang.String, java.lang.String, long)" target="_top"><tt>newDefaultInformation</tt></A>(<code>String,</nobr> String<nobr>,</nobr> long<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP">Create ResourceInformation with basic fields.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.newInstance_added(long, int)"></A>
<nobr><code>Resource</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#newInstance(long, int)" target="_top"><tt>newInstance</tt></A>(<code>long,</nobr> int<nobr><nobr></code>)</nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.newInstance_added(long, int, java.util.Map)"></A>
<nobr><code>Resource</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#newInstance(long, int, java.util.Map)" target="_top"><tt>newInstance</tt></A>(<code>long,</nobr> int<nobr>,</nobr> Map<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP">Create a new <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/Resource.html" target="_top">Resource</A> instance with the given CPU and memory values and additional resource values as set in the {@code others} parameter.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.setMemorySize_added(long)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#setMemorySize(long)" target="_top"><tt>setMemorySize</tt></A>(<code>long</code>)</nobr>
</TD>
<TD VALIGN="TOP">Set <em>memory</em> of the resource.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.setResourceInformation_added(java.lang.String, org.apache.hadoop.yarn.api.records.ResourceInformation)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#setResourceInformation(java.lang.String, org.apache.hadoop.yarn.api.records.ResourceInformation)" target="_top"><tt>setResourceInformation</tt></A>(<code>String,</nobr> ResourceInformation<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP">Set the ResourceInformation object for a particular resource.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.setResourceValue_added(java.lang.String, long)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#setResourceValue(java.lang.String, long)" target="_top"><tt>setResourceValue</tt></A>(<code>String,</nobr> long<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP">Set the value of a resource in the ResourceInformation object.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.throwExceptionWhenArrayOutOfBound_added(int)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#throwExceptionWhenArrayOutOfBound(int)" target="_top"><tt>throwExceptionWhenArrayOutOfBound</tt></A>(<code>int</code>)</nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<a NAME="fields"></a>
<p>
<a NAME="Added"></a>
<TABLE summary="Added Fields" BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD VALIGN="TOP" COLSPAN=2><FONT SIZE="+1"><B>Added Fields</B></FONT></TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.MEMORY_INDEX"></A>
<nobr><code>int</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#MEMORY_INDEX" target="_top"><tt>MEMORY_INDEX</tt></A></nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.VCORES_INDEX"></A>
<nobr><code>int</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#VCORES_INDEX" target="_top"><tt>VCORES_INDEX</tt></A></nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.api.records.Resource.resources"></A>
<nobr><code>ResourceInformation[]</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html#resources" target="_top"><tt>resources</tt></A></nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<HR>
<!-- Start of nav bar -->
<TABLE summary="Navigation bar" BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<TABLE summary="Navigation bar" BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/apidocs/org/apache/hadoop/yarn/api/records/Resource.html" target="_top"><FONT CLASS="NavBarFont1"><B><tt>Apache Hadoop YARN API 3.3.1</tt></B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="changes-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="pkg_org.apache.hadoop.yarn.api.records.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="jdiff_statistics.html"><FONT CLASS="NavBarFont1"><B>Statistics</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="jdiff_help.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3></TD>
</TR>
<TR>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.ReservationDefinition.html"><B>PREV CLASS</B></A>
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.ResourceOption.html"><B>NEXT CLASS</B></A>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<A HREF="../changes.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="org.apache.hadoop.yarn.api.records.Resource.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
<TD BGCOLOR="0xFFFFFF" CLASS="NavBarCell3"></TD>
</TR>
</TABLE>
<HR>
<!-- End of nav bar -->
</BODY>
</HTML>