blob: 431ddb57533362f1230c7db6a2d49453ab652226 [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.client.api.YarnClient
</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-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html" target="_top"><FONT CLASS="NavBarFont1"><B><tt>Apache Hadoop YARN Client 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.client.api.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.client.api.SharedCacheClient.html"><B>PREV CLASS</B></A>
&nbsp;<B>NEXT CLASS</B>&nbsp;
&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.client.api.YarnClient.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;
FIELDS
</FONT></TD>
</TR>
</TABLE>
<HR>
<!-- End of nav bar -->
<H2>
Class org.apache.hadoop.yarn.client.api.<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html" target="_top"><tt>YarnClient</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.client.api.YarnClient.createReservation_added()"></A>
<nobr><code>GetNewReservationResponse</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#createReservation()" target="_top"><tt>createReservation</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP"><p> Obtain a <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/GetNewReservationResponse.html" target="_top">GetNewReservationResponse</A> for a new reservation which contains the <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/ReservationId.html" target="_top">ReservationId</A> object.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.failApplicationAttempt_added(org.apache.hadoop.yarn.api.records.ApplicationAttemptId)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#failApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId)" target="_top"><tt>failApplicationAttempt</tt></A>(<code>ApplicationAttemptId</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Fail an application attempt identified by given ID.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getApplications_added(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest)"></A>
<nobr><code>List</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest)" target="_top"><tt>getApplications</tt></A>(<code>GetApplicationsRequest</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Get a list of ApplicationReports that match the given <A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/GetApplicationsRequest.html" target="_top">GetApplicationsRequest</A> </p> </TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getApplications_added(java.util.Set, java.util.EnumSet, java.util.Set)"></A>
<nobr><code>List</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getApplications(java.util.Set, java.util.EnumSet, java.util.Set)" target="_top"><tt>getApplications</tt></A>(<code>Set,</nobr> EnumSet<nobr>,</nobr> Set<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Get a report (ApplicationReport) of Applications matching the given application types application states and application tags in the cluster.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getApplications_added(java.util.Set, java.util.Set, java.util.Set, java.util.EnumSet)"></A>
<nobr><code>List</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getApplications(java.util.Set, java.util.Set, java.util.Set, java.util.EnumSet)" target="_top"><tt>getApplications</tt></A>(<code>Set,</nobr> Set<nobr>,</nobr> Set<nobr>,</nobr> EnumSet<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Get a report (ApplicationReport) of Applications matching the given users queues application types and application states in the cluster.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getAttributesToNodes_added(java.util.Set)"></A>
<nobr><code>Map</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getAttributesToNodes(java.util.Set)" target="_top"><tt>getAttributesToNodes</tt></A>(<code>Set</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to get mapping of AttributeKey to associated NodeToAttributeValue list for specified node attributeKeys in the cluster.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getClusterAttributes_added()"></A>
<nobr><code>Set</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getClusterAttributes()" target="_top"><tt>getClusterAttributes</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to get node attributes in the cluster.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getNodeToAttributes_added(java.util.Set)"></A>
<nobr><code>Map</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getNodeToAttributes(java.util.Set)" target="_top"><tt>getNodeToAttributes</tt></A>(<code>Set</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to get all node to attribute mapping in existing cluster.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getResourceProfile_added(java.lang.String)"></A>
<nobr><code>Resource</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getResourceProfile(java.lang.String)" target="_top"><tt>getResourceProfile</tt></A>(<code>String</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Get the details of a specific resource profile from the RM.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getResourceProfiles_added()"></A>
<nobr><code>Map</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getResourceProfiles()" target="_top"><tt>getResourceProfiles</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP"><p> Get the resource profiles available in the RM.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getResourceTypeInfo_added()"></A>
<nobr><code>List</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getResourceTypeInfo()" target="_top"><tt>getResourceTypeInfo</tt></A>()</nobr>
</TD>
<TD VALIGN="TOP"><p> Get available resource types supported by RM.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.killApplication_added(org.apache.hadoop.yarn.api.records.ApplicationId, java.lang.String)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#killApplication(org.apache.hadoop.yarn.api.records.ApplicationId, java.lang.String)" target="_top"><tt>killApplication</tt></A>(<code>ApplicationId,</nobr> String<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Kill an application identified by given ID.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.listReservations_added(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest)"></A>
<nobr><code>ReservationListResponse</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest)" target="_top"><tt>listReservations</tt></A>(<code>ReservationListRequest</code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by clients to get the list of reservations in a plan.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.shellToContainer_added(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.ShellContainerCommand)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#shellToContainer(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.ShellContainerCommand)" target="_top"><tt>shellToContainer</tt></A>(<code>ContainerId,</nobr> ShellContainerCommand<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to get a shell to a container.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.signalToContainer_added(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.SignalContainerCommand)"></A>
<nobr><code>void</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#signalToContainer(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.SignalContainerCommand)" target="_top"><tt>signalToContainer</tt></A>(<code>ContainerId,</nobr> SignalContainerCommand<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> Signal a container identified by given ID.</TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.updateApplicationPriority_added(org.apache.hadoop.yarn.api.records.ApplicationId, org.apache.hadoop.yarn.api.records.Priority)"></A>
<nobr><code>Priority</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#updateApplicationPriority(org.apache.hadoop.yarn.api.records.ApplicationId, org.apache.hadoop.yarn.api.records.Priority)" target="_top"><tt>updateApplicationPriority</tt></A>(<code>ApplicationId,</nobr> Priority<nobr><nobr></code>)</nobr>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to set priority of an application </p> </TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.updateApplicationTimeouts_added(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest)"></A>
<nobr><code>UpdateApplicationTimeoutsResponse</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest)" target="_top"><tt>updateApplicationTimeouts</tt></A>(<code>UpdateApplicationTimeoutsRequest</code>)</nobr>
</TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<p>
<a NAME="Changed"></a>
<TABLE summary="Changed Methods" BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD VALIGN="TOP" COLSPAN=3><FONT SIZE="+1"><B>Changed Methods</B></FONT></TD>
</TR>
<TR BGCOLOR="#FFFFFF" CLASS="TableRowColor">
<TD VALIGN="TOP" WIDTH="25%">
<A NAME="org.apache.hadoop.yarn.client.api.YarnClient.getClusterNodeLabels_changed()"></A>
<nobr><code>List</code>&nbsp;<A HREF="/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html#getClusterNodeLabels()" target="_top"><tt>getClusterNodeLabels</tt></A>() </nobr>
</TD>
<TD VALIGN="TOP" WIDTH="30%">
Change in return type from <code>Set</code> to <code>List</code>.<br>
</TD>
<TD VALIGN="TOP"><p> The interface used by client to get node labels in the cluster </p> </TD>
</TR>
</TABLE>
&nbsp;
<a NAME="fields"></a>
<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-client/target/site/apidocs/org/apache/hadoop/yarn/client/api/YarnClient.html" target="_top"><FONT CLASS="NavBarFont1"><B><tt>Apache Hadoop YARN Client 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.client.api.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.client.api.SharedCacheClient.html"><B>PREV CLASS</B></A>
&nbsp;<B>NEXT CLASS</B>&nbsp;
&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.client.api.YarnClient.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>