Google Git
Sign in
apache / hadoop / refs/heads/branch-3.1.2 / . / hadoop-yarn-project / hadoop-yarn / dev-support / jdiff / Apache_Hadoop_YARN_API_2.6.0.xml
blob: a03d7a7ded69a587f0935908fa900ff068fc95b9 [file] [log] [blame]
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<!-- on Wed Apr 08 11:29:43 PDT 2015 -->
<api
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='api.xsd'
name="hadoop-yarn-api 2.6.0"
jdversion="1.0.9">
<!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/llu/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/llu/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/llu/.m2/repository/com/google/code/findbugs/jsr305/1.3.9/jsr305-1.3.9.jar:/Users/llu/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-common/2.6.0/hadoop-common-2.6.0.jar:/Users/llu/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/llu/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/llu/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/llu/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/llu/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/llu/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/llu/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/llu/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/Users/llu/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/llu/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/llu/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/llu/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/llu/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/llu/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/llu/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/llu/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/llu/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/llu/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/llu/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/llu/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/llu/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-api/1.7.5/slf4j-api-1.7.5.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-log4j12/1.7.5/slf4j-log4j12-1.7.5.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/llu/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/llu/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/llu/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/llu/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-auth/2.6.0/hadoop-auth-2.6.0.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/curator/curator-framework/2.6.0/curator-framework-2.6.0.jar:/Users/llu/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/llu/.m2/repository/org/apache/curator/curator-client/2.6.0/curator-client-2.6.0.jar:/Users/llu/.m2/repository/org/apache/curator/curator-recipes/2.6.0/curator-recipes-2.6.0.jar:/Users/llu/.m2/repository/org/htrace/htrace-core/3.0.4/htrace-core-3.0.4.jar:/Users/llu/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/llu/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/llu/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/llu/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-annotations/2.6.0/hadoop-annotations-2.6.0.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_67.jdk/Contents/Home/lib/tools.jar:/Users/llu/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.6.0 -->
<package name="org.apache.hadoop.yarn.api">
<!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
<interface name="ApplicationClientProtocol" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
submitting new applications.</p>
<p>The <code>ResourceManager</code> responds with a new, monotonically
increasing, {@link ApplicationId} which is used by the client to submit
a new application.</p>
<p>The <code>ResourceManager</code> also responds with details such
as maximum resource capabilities in the cluster as specified in
{@link GetNewApplicationResponse}.</p>
@param request request to get a new <code>ApplicationId</code>
@return response containing the new <code>ApplicationId</code> to be used
to submit an application
@throws YarnException
@throws IOException
@see #submitApplication(SubmitApplicationRequest)]]>
</doc>
</method>
<method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to submit a new application to the
<code>ResourceManager.</code></p>
<p>The client is required to provide details such as queue,
{@link Resource} required to run the <code>ApplicationMaster</code>,
the equivalent of {@link ContainerLaunchContext} for launching
the <code>ApplicationMaster</code> etc. via the
{@link SubmitApplicationRequest}.</p>
<p>Currently the <code>ResourceManager</code> sends an immediate (empty)
{@link SubmitApplicationResponse} on accepting the submission and throws
an exception if it rejects the submission. However, this call needs to be
followed by {@link #getApplicationReport(GetApplicationReportRequest)}
to make sure that the application gets properly submitted - obtaining a
{@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
that RM 'remembers' this application beyond failover or restart. If RM
failover or RM restart happens before ResourceManager saves the
application's state successfully, the subsequent
{@link #getApplicationReport(GetApplicationReportRequest)} will throw
a {@link ApplicationNotFoundException}. The Clients need to re-submit
the application with the same {@link ApplicationSubmissionContext} when
it encounters the {@link ApplicationNotFoundException} on the
{@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
<p>During the submission process, it checks whether the application
already exists. If the application exists, it will simply return
SubmitApplicationResponse</p>
<p> In secure mode,the <code>ResourceManager</code> verifies access to
queues etc. before accepting the application submission.</p>
@param request request to submit a new application
@return (empty) response on accepting the submission
@throws YarnException
@throws IOException
@throws InvalidResourceRequestException
The exception is thrown when a {@link ResourceRequest} is out of
the range of the configured lower and upper resource boundaries.
@see #getNewApplication(GetNewApplicationRequest)]]>
</doc>
</method>
<method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to request the
<code>ResourceManager</code> to abort submitted application.</p>
<p>The client, via {@link KillApplicationRequest} provides the
{@link ApplicationId} of the application to be aborted.</p>
<p> In secure mode,the <code>ResourceManager</code> verifies access to the
application, queue etc. before terminating the application.</p>
<p>Currently, the <code>ResourceManager</code> returns an empty response
on success and throws an exception on rejecting the request.</p>
@param request request to abort a submitted application
@return <code>ResourceManager</code> returns an empty response
on success and throws an exception on rejecting the request
@throws YarnException
@throws IOException
@see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
</doc>
</method>
<method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get a report of an Application from
the <code>ResourceManager</code>.</p>
<p>The client, via {@link GetApplicationReportRequest} provides the
{@link ApplicationId} of the application.</p>
<p> In secure mode,the <code>ResourceManager</code> verifies access to the
application, queue etc. before accepting the request.</p>
<p>The <code>ResourceManager</code> responds with a
{@link GetApplicationReportResponse} which includes the
{@link ApplicationReport} for the application.</p>
<p>If the user does not have <code>VIEW_APP</code> access then the
following fields in the report will be set to stubbed values:
<ul>
<li>host - set to "N/A"</li>
<li>RPC port - set to -1</li>
<li>client token - set to "N/A"</li>
<li>diagnostics - set to "N/A"</li>
<li>tracking URL - set to "N/A"</li>
<li>original tracking URL - set to "N/A"</li>
<li>resource usage report - all values are -1</li>
</ul></p>
@param request request for an application report
@return application report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get metrics about the cluster from
the <code>ResourceManager</code>.</p>
<p>The <code>ResourceManager</code> responds with a
{@link GetClusterMetricsResponse} which includes the
{@link YarnClusterMetrics} with details such as number of current
nodes in the cluster.</p>
@param request request for cluster metrics
@return cluster metrics
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get a report of Applications
matching the filters defined by {@link GetApplicationsRequest}
in the cluster from the <code>ResourceManager</code>.</p>
<p>The <code>ResourceManager</code> responds with a
{@link GetApplicationsResponse} which includes the
{@link ApplicationReport} for the applications.</p>
<p>If the user does not have <code>VIEW_APP</code> access for an
application then the corresponding report will be filtered as
described in {@link #getApplicationReport(GetApplicationReportRequest)}.
</p>
@param request request for report on applications
@return report on applications matching the given application types
defined in the request
@throws YarnException
@throws IOException
@see GetApplicationsRequest]]>
</doc>
</method>
<method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get a report of all nodes
in the cluster from the <code>ResourceManager</code>.</p>
<p>The <code>ResourceManager</code> responds with a
{@link GetClusterNodesResponse} which includes the
{@link NodeReport} for all the nodes in the cluster.</p>
@param request request for report on all nodes
@return report on all nodes
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get information about <em>queues</em>
from the <code>ResourceManager</code>.</p>
<p>The client, via {@link GetQueueInfoRequest}, can ask for details such
as used/total resources, child queues, running applications etc.</p>
<p> In secure mode,the <code>ResourceManager</code> verifies access before
providing the information.</p>
@param request request to get queue information
@return queue information
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get information about <em>queue
acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
</p>
<p>The <code>ResourceManager</code> responds with queue acls for all
existing queues.</p>
@param request request to get queue acls for <em>current user</em>
@return queue acls for <em>current user</em>
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by clients to get delegation token, enabling the
containers to be able to talk to the service using those tokens.
<p> The <code>ResourceManager</code> responds with the delegation
{@link Token} that can be used by the client to speak to this
service.
@param request request to get a delegation token for the client.
@return delegation token that can be used to talk to this service
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Move an application to a new queue.
@param request the application ID and the target queue
@return an empty response
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of an Application Attempt
from the <code>ResourceManager</code>
</p>
<p>
The client, via {@link GetApplicationAttemptReportRequest} provides the
{@link ApplicationAttemptId} of the application attempt.
</p>
<p>
In secure mode,the <code>ResourceManager</code> verifies access to
the method before accepting the request.
</p>
<p>
The <code>ResourceManager</code> responds with a
{@link GetApplicationAttemptReportResponse} which includes the
{@link ApplicationAttemptReport} for the application attempt.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access then the following
fields in the report will be set to stubbed values:
<ul>
<li>host</li>
<li>RPC port</li>
<li>client token</li>
<li>diagnostics - set to "N/A"</li>
<li>tracking URL</li>
</ul>
</p>
@param request
request for an application attempt report
@return application attempt report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of all Application attempts
in the cluster from the <code>ResourceManager</code>
</p>
<p>
The <code>ResourceManager</code> responds with a
{@link GetApplicationAttemptsRequest} which includes the
{@link ApplicationAttemptReport} for all the applications attempts of a
specified application attempt.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access for an application
then the corresponding report will be filtered as described in
{@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
</p>
@param request
request for reports on all application attempts of an application
@return reports on all application attempts of an application
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of an Container from the
<code>ResourceManager</code>
</p>
<p>
The client, via {@link GetContainerReportRequest} provides the
{@link ContainerId} of the container.
</p>
<p>
In secure mode,the <code>ResourceManager</code> verifies access to the
method before accepting the request.
</p>
<p>
The <code>ResourceManager</code> responds with a
{@link GetContainerReportResponse} which includes the
{@link ContainerReport} for the container.
</p>
@param request
request for a container report
@return container report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of Containers for an
application attempt from the <code>ResourceManager</code>
</p>
<p>
The client, via {@link GetContainersRequest} provides the
{@link ApplicationAttemptId} of the application attempt.
</p>
<p>
In secure mode,the <code>ResourceManager</code> verifies access to the
method before accepting the request.
</p>
<p>
The <code>ResourceManager</code> responds with a
{@link GetContainersResponse} which includes a list of
{@link ContainerReport} for all the containers of a specific application
attempt.
</p>
@param request
request for a list of container reports of an application attempt.
@return reports on all containers of an application attempt
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to submit a new reservation to the
{@code ResourceManager}.
</p>
<p>
The client packages all details of its request in a
{@link ReservationSubmissionRequest} object. This contains information
about the amount of capacity, temporal constraints, and concurrency needs.
Furthermore, the reservation might be composed of multiple stages, with
ordering dependencies among them.
</p>
<p>
In order to respond, a new admission control component in the
{@code ResourceManager} performs an analysis of the resources that have
been committed over the period of time the user is requesting, verify that
the user requests can be fulfilled, and that it respect a sharing policy
(e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
that the ReservationSubmissionRequest is satisfiable the
{@code ResourceManager} answers with a
{@link ReservationSubmissionResponse} that include a non-null
{@link ReservationId}. Upon failure to find a valid allocation the response
is an exception with the reason.
On application submission the client can use this {@link ReservationId} to
obtain access to the reserved resources.
</p>
<p>
The system guarantees that during the time-range specified by the user, the
reservationID will be corresponding to a valid reservation. The amount of
capacity dedicated to such queue can vary overtime, depending of the
allocation that has been determined. But it is guaranteed to satisfy all
the constraint expressed by the user in the
{@link ReservationSubmissionRequest}.
</p>
@param request the request to submit a new Reservation
@return response the {@link ReservationId} on accepting the submission
@throws YarnException if the request is invalid or reservation cannot be
created successfully
@throws IOException]]>
</doc>
</method>
<method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to update an existing Reservation. This is
referred to as a re-negotiation process, in which a user that has
previously submitted a Reservation.
</p>
<p>
The allocation is attempted by virtually substituting all previous
allocations related to this Reservation with new ones, that satisfy the new
{@link ReservationUpdateRequest}. Upon success the previous allocation is
substituted by the new one, and on failure (i.e., if the system cannot find
a valid allocation for the updated request), the previous allocation
remains valid.
The {@link ReservationId} is not changed, and applications currently
running within this reservation will automatically receive the resources
based on the new allocation.
</p>
@param request to update an existing Reservation (the ReservationRequest
should refer to an existing valid {@link ReservationId})
@return response empty on successfully updating the existing reservation
@throws YarnException if the request is invalid or reservation cannot be
updated successfully
@throws IOException]]>
</doc>
</method>
<method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to remove an existing Reservation.
Upon deletion of a reservation applications running with this reservation,
are automatically downgraded to normal jobs running without any dedicated
reservation.
</p>
@param request to remove an existing Reservation (the ReservationRequest
should refer to an existing valid {@link ReservationId})
@return response empty on successfully deleting the existing reservation
@throws YarnException if the request is invalid or reservation cannot be
deleted successfully
@throws IOException]]>
</doc>
</method>
<method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by client to get node to labels mappings in existing cluster
</p>
@param request
@return node to labels mappings
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by client to get node labels in the cluster
</p>
@param request to get node labels collection of this cluster
@return node labels collection of this cluster
@throws YarnException
@throws IOException]]>
</doc>
</method>
<doc>
<![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
to submit/abort jobs and to get information on applications, cluster metrics,
nodes, queues and ACLs.</p>]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
<!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
<interface name="ApplicationConstants" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
only]]>
</doc>
</field>
<field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The cache file into which container token is written]]>
</doc>
</field>
<field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
ApplicationMaster's environment only. This states that for all non-relative
web URLs in the app masters web UI what base should they have.]]>
</doc>
</field>
<field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The temporary environmental variable for container log directory. This
should be replaced by real container log directory on container launch.]]>
</doc>
</field>
<field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[This constant is used to construct class path and it will be replaced with
real class path separator(':' for Linux and ';' for Windows) by
NodeManager on container launch. User has to use this constant to construct
class path if user wants cross-platform practice i.e. submit an application
from a Windows client to a Linux/Unix server or vice versa.]]>
</doc>
</field>
<field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The following two constants are used to expand parameter and it will be
replaced with real parameter expansion marker ('%' for Windows and '$' for
Linux) by NodeManager on container launch. For example: {{VAR}} will be
replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
constant to construct class path if user wants cross-platform practice i.e.
submit an application from a Windows client to a Linux/Unix server or vice
versa.]]>
</doc>
</field>
<field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[User has to use this constant to construct class path if user wants
cross-platform practice i.e. submit an application from a Windows client to
a Linux/Unix server or vice versa.]]>
</doc>
</field>
<field name="STDERR" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="STDOUT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
only]]>
</doc>
</field>
<doc>
<![CDATA[This is the API for the applications comprising of constants that YARN sets
up for the applications and the containers.
TODO: Investigate the semantics and security of each cross-boundary refs.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
<!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
<class name="ApplicationConstants.Environment" extends="java.lang.Enum"
abstract="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
</method>
<method name="key" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="$" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Expand the environment variable based on client OS environment variable
expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).
<p>
Note: Use $$() method for cross-platform practice i.e. submit an
application from a Windows client to a Linux/Unix server or vice versa.
</p>]]>
</doc>
</method>
<method name="$$" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Expand the environment variable in platform-agnostic syntax. The
parameter expansion marker "{{VAR}}" will be replaced with real parameter
expansion marker ('%' for Windows and '$' for Linux) by NodeManager on
container launch. For example: {{VAR}} will be replaced as $VAR on Linux,
and %VAR% on Windows.]]>
</doc>
</method>
<doc>
<![CDATA[Environment for Applications.
Some of the environment variables for applications are <em>final</em>
i.e. they cannot be modified by the applications.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
<!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
<interface name="ApplicationHistoryProtocol" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of an Application from the
<code>ResourceManager</code>.
</p>
<p>
The client, via {@link GetApplicationReportRequest} provides the
{@link ApplicationId} of the application.
</p>
<p>
In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
the application, queue etc. before accepting the request.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetApplicationReportResponse} which includes the
{@link ApplicationReport} for the application.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access then the following
fields in the report will be set to stubbed values:
<ul>
<li>host - set to "N/A"</li>
<li>RPC port - set to -1</li>
<li>client token - set to "N/A"</li>
<li>diagnostics - set to "N/A"</li>
<li>tracking URL - set to "N/A"</li>
<li>original tracking URL - set to "N/A"</li>
<li>resource usage report - all values are -1</li>
</ul>
</p>
@param request
request for an application report
@return application report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of all Applications in the
cluster from the <code>ApplicationHistoryServer</code>.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetApplicationsResponse} which includes a list of
{@link ApplicationReport} for all the applications.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access for an application
then the corresponding report will be filtered as described in
{@link #getApplicationReport(GetApplicationReportRequest)}.
</p>
@param request
request for reports on all the applications
@return report on applications matching the given application types defined
in the request
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of an Application Attempt
from the <code>ApplicationHistoryServer</code>.
</p>
<p>
The client, via {@link GetApplicationAttemptReportRequest} provides the
{@link ApplicationAttemptId} of the application attempt.
</p>
<p>
In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
the method before accepting the request.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetApplicationAttemptReportResponse} which includes the
{@link ApplicationAttemptReport} for the application attempt.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access then the following
fields in the report will be set to stubbed values:
<ul>
<li>host</li>
<li>RPC port</li>
<li>client token</li>
<li>diagnostics - set to "N/A"</li>
<li>tracking URL</li>
</ul>
</p>
@param request
request for an application attempt report
@return application attempt report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of all Application attempts
in the cluster from the <code>ApplicationHistoryServer</code>.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetApplicationAttemptsRequest} which includes the
{@link ApplicationAttemptReport} for all the applications attempts of a
specified application attempt.
</p>
<p>
If the user does not have <code>VIEW_APP</code> access for an application
then the corresponding report will be filtered as described in
{@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
</p>
@param request
request for reports on all application attempts of an application
@return reports on all application attempts of an application
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of an Container from the
<code>ApplicationHistoryServer</code>.
</p>
<p>
The client, via {@link GetContainerReportRequest} provides the
{@link ContainerId} of the container.
</p>
<p>
In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
the method before accepting the request.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetContainerReportResponse} which includes the
{@link ContainerReport} for the container.
</p>
@param request
request for a container report
@return container report
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get a report of Containers for an
application attempt from the <code>ApplciationHistoryServer</code>.
</p>
<p>
The client, via {@link GetContainersRequest} provides the
{@link ApplicationAttemptId} of the application attempt.
</p>
<p>
In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
the method before accepting the request.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with a
{@link GetContainersResponse} which includes a list of
{@link ContainerReport} for all the containers of a specific application
attempt.
</p>
@param request
request for a list of container reports of an application attempt.
@return reports on all containers of an application attempt
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by clients to get delegation token, enabling the
containers to be able to talk to the service using those tokens.
</p>
<p>
The <code>ApplicationHistoryServer</code> responds with the delegation
token {@link Token} that can be used by the client to speak to this
service.
</p>
@param request
request to get a delegation token for the client.
@return delegation token that can be used to talk to this service
@throws YarnException
@throws IOException]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The protocol between clients and the <code>ApplicationHistoryServer</code> to
get the information of completed applications etc.
</p>]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
<!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
<interface name="ApplicationMasterProtocol" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The interface used by a new <code>ApplicationMaster</code> to register with
the <code>ResourceManager</code>.
</p>
<p>
The <code>ApplicationMaster</code> needs to provide details such as RPC
Port, HTTP tracking url etc. as specified in
{@link RegisterApplicationMasterRequest}.
</p>
<p>
The <code>ResourceManager</code> responds with critical details such as
maximum resource capabilities in the cluster as specified in
{@link RegisterApplicationMasterResponse}.
</p>
@param request
registration request
@return registration respose
@throws YarnException
@throws IOException
@throws InvalidApplicationMasterRequestException
The exception is thrown when an ApplicationMaster tries to
register more then once.
@see RegisterApplicationMasterRequest
@see RegisterApplicationMasterResponse]]>
</doc>
</method>
<method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
<code>ResourceManager</code> about its completion (success or failed).</p>
<p>The <code>ApplicationMaster</code> has to provide details such as
final state, diagnostics (in case of failures) etc. as specified in
{@link FinishApplicationMasterRequest}.</p>
<p>The <code>ResourceManager</code> responds with
{@link FinishApplicationMasterResponse}.</p>
@param request completion request
@return completion response
@throws YarnException
@throws IOException
@see FinishApplicationMasterRequest
@see FinishApplicationMasterResponse]]>
</doc>
</method>
<method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The main interface between an <code>ApplicationMaster</code> and the
<code>ResourceManager</code>.
</p>
<p>
The <code>ApplicationMaster</code> uses this interface to provide a list of
{@link ResourceRequest} and returns unused {@link Container} allocated to
it via {@link AllocateRequest}. Optionally, the
<code>ApplicationMaster</code> can also <em>blacklist</em> resources which
it doesn't want to use.
</p>
<p>
This also doubles up as a <em>heartbeat</em> to let the
<code>ResourceManager</code> know that the <code>ApplicationMaster</code>
is alive. Thus, applications should periodically make this call to be kept
alive. The frequency depends on
{@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
{@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
</p>
<p>
The <code>ResourceManager</code> responds with list of allocated
{@link Container}, status of completed containers and headroom information
for the application.
</p>
<p>
The <code>ApplicationMaster</code> can use the available headroom
(resources) to decide how to utilized allocated resources and make informed
decisions about future resource requests.
</p>
@param request
allocation request
@return allocation response
@throws YarnException
@throws IOException
@throws InvalidApplicationMasterRequestException
This exception is thrown when an ApplicationMaster calls allocate
without registering first.
@throws InvalidResourceBlacklistRequestException
This exception is thrown when an application provides an invalid
specification for blacklist of resources.
@throws InvalidResourceRequestException
This exception is thrown when a {@link ResourceRequest} is out of
the range of the configured lower and upper limits on the
resources.
@see AllocateRequest
@see AllocateResponse]]>
</doc>
</method>
<doc>
<![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
and the <code>ResourceManager</code>.</p>
<p>This is used by the <code>ApplicationMaster</code> to register/unregister
and to request and obtain resources in the cluster from the
<code>ResourceManager</code>.</p>]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
<!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
<interface name="ContainerManagementProtocol" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The <code>ApplicationMaster</code> provides a list of
{@link StartContainerRequest}s to a <code>NodeManager</code> to
<em>start</em> {@link Container}s allocated to it using this interface.
</p>
<p>
The <code>ApplicationMaster</code> has to provide details such as allocated
resource capability, security tokens (if enabled), command to be executed
to start the container, environment for the process, necessary
binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
the {@link StartContainerRequest}.
</p>
<p>
The <code>NodeManager</code> sends a response via
{@link StartContainersResponse} which includes a list of
{@link Container}s of successfully launched {@link Container}s, a
containerId-to-exception map for each failed {@link StartContainerRequest} in
which the exception indicates errors from per container and a
allServicesMetaData map between the names of auxiliary services and their
corresponding meta-data. Note: None-container-specific exceptions will
still be thrown by the API method itself.
</p>
<p>
The <code>ApplicationMaster</code> can use
{@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
statuses of the to-be-launched or launched containers.
</p>
@param request
request to start a list of containers
@return response including conatinerIds of all successfully launched
containers, a containerId-to-exception map for failed requests and
a allServicesMetaData map.
@throws YarnException
@throws IOException
@throws NMNotYetReadyException
This exception is thrown when NM starts from scratch but has not
yet connected with RM.]]>
</doc>
</method>
<method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
<em>stop</em> a list of {@link Container}s allocated to it using this
interface.
</p>
<p>
The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
which includes the {@link ContainerId}s of the containers to be stopped.
</p>
<p>
The <code>NodeManager</code> sends a response via
{@link StopContainersResponse} which includes a list of {@link ContainerId}
s of successfully stopped containers, a containerId-to-exception map for
each failed request in which the exception indicates errors from per
container. Note: None-container-specific exceptions will still be thrown by
the API method itself. <code>ApplicationMaster</code> can use
{@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
statuses of the containers.
</p>
@param request
request to stop a list of containers
@return response which includes a list of containerIds of successfully
stopped containers, a containerId-to-exception map for failed
requests.
@throws YarnException
@throws IOException]]>
</doc>
</method>
<method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
<exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>
The API used by the <code>ApplicationMaster</code> to request for current
statuses of <code>Container</code>s from the <code>NodeManager</code>.
</p>
<p>
The <code>ApplicationMaster</code> sends a
{@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
of all containers whose statuses are needed.
</p>
<p>
The <code>NodeManager</code> responds with
{@link GetContainerStatusesResponse} which includes a list of
{@link ContainerStatus} of the successfully queried containers and a
containerId-to-exception map for each failed request in which the exception
indicates errors from per container. Note: None-container-specific
exceptions will still be thrown by the API method itself.
</p>
@param request
request to get <code>ContainerStatus</code>es of containers with
the specified <code>ContainerId</code>s
@return response containing the list of <code>ContainerStatus</code> of the
successfully queried containers and a containerId-to-exception map
for failed requests.
@throws YarnException
@throws IOException]]>
</doc>
</method>
<doc>
<![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
<code>NodeManager</code> to start/stop containers and to get status
of running containers.</p>
<p>If security is enabled the <code>NodeManager</code> verifies that the
<code>ApplicationMaster</code> has truly been allocated the container
by the <code>ResourceManager</code> and also verifies all interactions such
as stopping the container or obtaining status information for the container.
</p>]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
</package>
<package name="org.apache.hadoop.yarn.api.protocolrecords">
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
<class name="AllocateRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="AllocateRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="responseID" type="int"/>
<param name="appProgress" type="float"/>
<param name="resourceAsk" type="java.util.List"/>
<param name="containersToBeReleased" type="java.util.List"/>
<param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="responseID" type="int"/>
<param name="appProgress" type="float"/>
<param name="resourceAsk" type="java.util.List"/>
<param name="containersToBeReleased" type="java.util.List"/>
<param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
<param name="increaseRequests" type="java.util.List"/>
</method>
<method name="getResponseId" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <em>response id</em> used to track duplicate responses.
@return <em>response id</em>]]>
</doc>
</method>
<method name="setResponseId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="id" type="int"/>
<doc>
<![CDATA[Set the <em>response id</em> used to track duplicate responses.
@param id <em>response id</em>]]>
</doc>
</method>
<method name="getProgress" return="float"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <em>current progress</em> of application.
@return <em>current progress</em> of application]]>
</doc>
</method>
<method name="setProgress"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="progress" type="float"/>
<doc>
<![CDATA[Set the <em>current progress</em> of application
@param progress <em>current progress</em> of application]]>
</doc>
</method>
<method name="getAskList" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <code>ResourceRequest</code> to update the
<code>ResourceManager</code> about the application's resource requirements.
@return the list of <code>ResourceRequest</code>
@see ResourceRequest]]>
</doc>
</method>
<method name="setAskList"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="resourceRequests" type="java.util.List"/>
<doc>
<![CDATA[Set list of <code>ResourceRequest</code> to update the
<code>ResourceManager</code> about the application's resource requirements.
@param resourceRequests list of <code>ResourceRequest</code> to update the
<code>ResourceManager</code> about the application's
resource requirements
@see ResourceRequest]]>
</doc>
</method>
<method name="getReleaseList" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <code>ContainerId</code> of containers being
released by the <code>ApplicationMaster</code>.
@return list of <code>ContainerId</code> of containers being
released by the <code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="setReleaseList"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="releaseContainers" type="java.util.List"/>
<doc>
<![CDATA[Set the list of <code>ContainerId</code> of containers being
released by the <code>ApplicationMaster</code>
@param releaseContainers list of <code>ContainerId</code> of
containers being released by the
<code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
<code>ApplicationMaster</code>.
@return the <code>ResourceBlacklistRequest</code> being sent by the
<code>ApplicationMaster</code>
@see ResourceBlacklistRequest]]>
</doc>
</method>
<method name="setResourceBlacklistRequest"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
<doc>
<![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
<code>ResourceManager</code> about the blacklist additions and removals
per the <code>ApplicationMaster</code>.
@param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
to inform the <code>ResourceManager</code> about
the blacklist additions and removals
per the <code>ApplicationMaster</code>
@see ResourceBlacklistRequest]]>
</doc>
</method>
<method name="getIncreaseRequests" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
<code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="setIncreaseRequests"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="increaseRequests" type="java.util.List"/>
<doc>
<![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
<code>ResourceManager</code> about some container's resources need to be
increased]]>
</doc>
</method>
<doc>
<![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
<code>ResourceManager</code> to obtain resources in the cluster.</p>
<p>The request includes:
<ul>
<li>A response id to track duplicate responses.</li>
<li>Progress information.</li>
<li>
A list of {@link ResourceRequest} to inform the
<code>ResourceManager</code> about the application's
resource requirements.
</li>
<li>
A list of unused {@link Container} which are being returned.
</li>
</ul>
</p>
@see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
<class name="AllocateResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="AllocateResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="responseId" type="int"/>
<param name="completedContainers" type="java.util.List"/>
<param name="allocatedContainers" type="java.util.List"/>
<param name="updatedNodes" type="java.util.List"/>
<param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
<param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
<param name="numClusterNodes" type="int"/>
<param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
<param name="nmTokens" type="java.util.List"/>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="responseId" type="int"/>
<param name="completedContainers" type="java.util.List"/>
<param name="allocatedContainers" type="java.util.List"/>
<param name="updatedNodes" type="java.util.List"/>
<param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
<param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
<param name="numClusterNodes" type="int"/>
<param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
<param name="nmTokens" type="java.util.List"/>
<param name="increasedContainers" type="java.util.List"/>
<param name="decreasedContainers" type="java.util.List"/>
</method>
<method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[If the <code>ResourceManager</code> needs the
<code>ApplicationMaster</code> to take some action then it will send an
AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
for details on commands and actions for them.
@return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
take action, <code>null</code> otherwise
@see AMCommand]]>
</doc>
</method>
<method name="getResponseId" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <em>last response id</em>.
@return <em>last response id</em>]]>
</doc>
</method>
<method name="getAllocatedContainers" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
<code>ResourceManager</code>.
@return list of <em>newly allocated</em> <code>Container</code>]]>
</doc>
</method>
<method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
application.
@return limit of available headroom for resources in the cluster for the
application]]>
</doc>
</method>
<method name="getCompletedContainersStatuses" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <em>completed containers' statuses</em>.
@return the list of <em>completed containers' statuses</em>]]>
</doc>
</method>
<method name="getUpdatedNodes" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
be changes in health, availability etc of the nodes.
@return The delta of updated nodes since the last response]]>
</doc>
</method>
<method name="getNumClusterNodes" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the number of hosts available on the cluster.
@return the available host count.]]>
</doc>
</method>
<method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[<p>Get the description of containers owned by the AM, but requested back by
the cluster. Note that the RM may have an inconsistent view of the
resources owned by the AM. These messages are advisory, and the AM may
elect to ignore them.<p>
<p>The message is a snapshot of the resources the RM wants back from the AM.
While demand persists, the RM will repeat its request; applications should
not interpret each message as a request for <em>additional<em>
resources on top of previous messages. Resources requested consistently
over some duration may be forcibly killed by the RM.<p>
@return A specification of the resources to reclaim from this AM.]]>
</doc>
</method>
<method name="getNMTokens" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[<p>Get the list of NMTokens required for communicating with NM. New NMTokens
issued only if<p>
<p>1) AM is receiving first container on underlying NodeManager.<br>
OR<br>
2) NMToken master key rolled over in ResourceManager and AM is getting new
container on the same underlying NodeManager.<p>
<p>AM will receive one NMToken per NM irrespective of the number of containers
issued on same NM. AM is expected to store these tokens until issued a
new token for the same NM.<p>]]>
</doc>
</method>
<method name="getIncreasedContainers" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
</doc>
</method>
<method name="getDecreasedContainers" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
</doc>
</method>
<method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The AMRMToken that belong to this attempt
@return The AMRMToken that belong to this attempt]]>
</doc>
</method>
<doc>
<![CDATA[<p>The response sent by the <code>ResourceManager</code> the
<code>ApplicationMaster</code> during resource negotiation.</p>
<p>The response, includes:
<ul>
<li>Response ID to track duplicate responses.</li>
<li>
An AMCommand sent by ResourceManager to let the <code>ApplicationMaster</code>
take some actions (resync, shutdown etc.).
<li>A list of newly allocated {@link Container}.</li>
<li>A list of completed {@link Container}s' statuses.</li>
<li>
The available headroom for resources in the cluster for the
application.
</li>
<li>A list of nodes whose status has been updated.</li>
<li>The number of available nodes in a cluster.</li>
<li>A description of resources requested back by the cluster</li>
<li>AMRMToken, if AMRMToken has been rolled over</li>
</ul>
</p>
@see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
<class name="ApplicationsRequestScope" extends="java.lang.Enum"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
</method>
<doc>
<![CDATA[Enumeration that controls the scope of applications fetched]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
<class name="FinishApplicationMasterRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FinishApplicationMasterRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
<param name="diagnostics" type="java.lang.String"/>
<param name="url" type="java.lang.String"/>
</method>
<method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
@return <em>final state</em> of the <code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="setFinalApplicationStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
<doc>
<![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
@param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="getDiagnostics" return="java.lang.String"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get <em>diagnostic information</em> on application failure.
@return <em>diagnostic information</em> on application failure]]>
</doc>
</method>
<method name="setDiagnostics"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="diagnostics" type="java.lang.String"/>
<doc>
<![CDATA[Set <em>diagnostic information</em> on application failure.
@param diagnostics <em>diagnostic information</em> on application failure]]>
</doc>
</method>
<method name="getTrackingUrl" return="java.lang.String"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
This url if contains scheme then that will be used by resource manager
web application proxy otherwise it will default to http.
@return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
</doc>
</method>
<method name="setTrackingUrl"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="url" type="java.lang.String"/>
<doc>
<![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
This is the web-URL to which ResourceManager or web-application proxy will
redirect client/users once the application is finished and the
<code>ApplicationMaster</code> is gone.
<p>
If the passed url has a scheme then that will be used by the
ResourceManager and web-application proxy, otherwise the scheme will
default to http.
</p>
<p>
Empty, null, "N/A" strings are all valid besides a real URL. In case an url
isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
<p>
@param url
<em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
</doc>
</method>
<doc>
<![CDATA[<p>The finalization request sent by the <code>ApplicationMaster</code> to
inform the <code>ResourceManager</code> about its completion.</p>
<p>The final request includes details such:
<ul>
<li>Final state of the <code>ApplicationMaster</code></li>
<li>
Diagnostic information in case of failure of the
<code>ApplicationMaster</code>
</li>
<li>Tracking URL</li>
</ul>
</p>
@see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
<class name="FinishApplicationMasterResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FinishApplicationMasterResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getIsUnregistered" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the flag which indicates that the application has successfully
unregistered with the RM and the application can safely stop.]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>ResourceManager</code> to a
<code>ApplicationMaster</code> on it's completion.
</p>
<p>
The response, includes:
<ul>
<li>A flag which indicates that the application has successfully unregistered
with the RM and the application can safely stop.</li>
</ul>
</p>
Note: The flag indicates whether the application has successfully
unregistered and is safe to stop. The application may stop after the flag is
true. If the application stops before the flag is true then the RM may retry
the application .
@see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
<class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationAttemptReportRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
</method>
<method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
@return <code>ApplicationAttemptId</code> of an application attempt]]>
</doc>
</method>
<method name="setApplicationAttemptId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
<doc>
<![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
@param applicationAttemptId
<code>ApplicationAttemptId</code> of an application attempt]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The request sent by a client to the <code>ResourceManager</code> to get an
{@link ApplicationAttemptReport} for an application attempt.
</p>
<p>
The request should include the {@link ApplicationAttemptId} of the
application attempt.
</p>
@see ApplicationAttemptReport
@see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
<class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationAttemptReportResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
</method>
<method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
@return <code>ApplicationAttemptReport</code> for the application attempt]]>
</doc>
</method>
<method name="setApplicationAttemptReport"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
<doc>
<![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
@param applicationAttemptReport
<code>ApplicationAttemptReport</code> for the application attempt]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>ResourceManager</code> to a client requesting
an application attempt report.
</p>
<p>
The response includes an {@link ApplicationAttemptReport} which has the
details about the particular application attempt
</p>
@see ApplicationAttemptReport
@see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
<class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationAttemptsRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
</method>
<method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationId</code> of an application
@return <code>ApplicationId</code> of an application]]>
</doc>
</method>
<method name="setApplicationId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
<doc>
<![CDATA[Set the <code>ApplicationId</code> of an application
@param applicationId
<code>ApplicationId</code> of an application]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The request from clients to get a list of application attempt reports of an
application from the <code>ResourceManager</code>.
</p>
@see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
<class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationAttemptsResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttempts" type="java.util.List"/>
</method>
<method name="getApplicationAttemptList" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a list of <code>ApplicationReport</code> of an application.
@return a list of <code>ApplicationReport</code> of an application]]>
</doc>
</method>
<method name="setApplicationAttemptList"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttempts" type="java.util.List"/>
<doc>
<![CDATA[Get a list of <code>ApplicationReport</code> of an application.
@param applicationAttempts
a list of <code>ApplicationReport</code> of an application]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>ResourceManager</code> to a client requesting
a list of {@link ApplicationAttemptReport} for application attempts.
</p>
<p>
The <code>ApplicationAttemptReport</code> for each application includes the
details of an application attempt.
</p>
@see ApplicationAttemptReport
@see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
<class name="GetApplicationReportRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationReportRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
</method>
<method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationId</code> of the application.
@return <code>ApplicationId</code> of the application]]>
</doc>
</method>
<method name="setApplicationId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
<doc>
<![CDATA[Set the <code>ApplicationId</code> of the application
@param applicationId <code>ApplicationId</code> of the application]]>
</doc>
</method>
<doc>
<![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
get an {@link ApplicationReport} for an application.</p>
<p>The request should include the {@link ApplicationId} of the
application.</p>
@see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
@see ApplicationReport]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
<class name="GetApplicationReportResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationReportResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationReport</code> for the application.
@return <code>ApplicationReport</code> for the application]]>
</doc>
</method>
<doc>
<![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
requesting an application report.</p>
<p>The response includes an {@link ApplicationReport} which has details such
as user, queue, name, host on which the <code>ApplicationMaster</code> is
running, RPC port, tracking URL, diagnostics, start time etc.</p>
@see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
<class name="GetApplicationsRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationsRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
<param name="users" type="java.util.Set"/>
<param name="queues" type="java.util.Set"/>
<param name="applicationTypes" type="java.util.Set"/>
<param name="applicationTags" type="java.util.Set"/>
<param name="applicationStates" type="java.util.EnumSet"/>
<param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
<param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
<param name="limit" type="java.lang.Long"/>
<doc>
<![CDATA[<p>
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
<code>ResourceManager</code>.
</p>
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
<p>Setting any of the parameters to null, would just disable that
filter</p>
@param scope {@link ApplicationsRequestScope} to filter by
@param users list of users to filter by
@param queues list of scheduler queues to filter by
@param applicationTypes types of applications
@param applicationTags application tags to filter by
@param applicationStates application states to filter by
@param startRange range of application start times to filter by
@param finishRange range of application finish times to filter by
@param limit number of applications to limit to
@return {@link GetApplicationsRequest} to be used with
{@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
<doc>
<![CDATA[<p>
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
<code>ResourceManager</code>.
</p>
@param scope {@link ApplicationsRequestScope} to filter by
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationTypes" type="java.util.Set"/>
<doc>
<![CDATA[<p>
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
<code>ResourceManager</code>.
</p>
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationStates" type="java.util.EnumSet"/>
<doc>
<![CDATA[<p>
The request from clients to get a report of Applications matching the
giving application states in the cluster from the
<code>ResourceManager</code>.
</p>
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationTypes" type="java.util.Set"/>
<param name="applicationStates" type="java.util.EnumSet"/>
<doc>
<![CDATA[<p>
The request from clients to get a report of Applications matching the
giving and application types and application types in the cluster from the
<code>ResourceManager</code>.
</p>
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</method>
<method name="getApplicationTypes" return="java.util.Set"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the application types to filter applications on
@return Set of Application Types to filter on]]>
</doc>
</method>
<method name="getApplicationStates" return="java.util.EnumSet"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the application states to filter applications on
@return Set of Application states to filter on]]>
</doc>
</method>
<doc>
<![CDATA[<p>The request from clients to get a report of Applications
in the cluster from the <code>ResourceManager</code>.</p>
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
<class name="GetApplicationsResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetApplicationsResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getApplicationList" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get <code>ApplicationReport</code> for applications.
@return <code>ApplicationReport</code> for applications]]>
</doc>
</method>
<doc>
<![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
requesting an {@link ApplicationReport} for applications.</p>
<p>The <code>ApplicationReport</code> for each application includes details
such as user, queue, name, host on which the <code>ApplicationMaster</code>
is running, RPC port, tracking URL, diagnostics, start time etc.</p>
@see ApplicationReport
@see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
<class name="GetClusterMetricsRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterMetricsRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[<p>The request sent by clients to get cluster metrics from the
<code>ResourceManager</code>.</p>
<p>Currently, this is empty.</p>
@see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
<class name="GetClusterMetricsResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterMetricsResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
@return <code>YarnClusterMetrics</code> for the cluster]]>
</doc>
</method>
<doc>
<![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
requesting cluster metrics.<p>
@see YarnClusterMetrics
@see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
<class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterNodeLabelsRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
<class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterNodeLabelsResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="labels" type="java.util.Set"/>
</method>
<method name="setNodeLabels"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="labels" type="java.util.Set"/>
</method>
<method name="getNodeLabels" return="java.util.Set"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
<class name="GetClusterNodesRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterNodesRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="states" type="java.util.EnumSet"/>
</method>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getNodeStates" return="java.util.EnumSet"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The state to filter the cluster nodes with.]]>
</doc>
</method>
<method name="setNodeStates"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="states" type="java.util.EnumSet"/>
<doc>
<![CDATA[The state to filter the cluster nodes with.]]>
</doc>
</method>
<doc>
<![CDATA[<p>The request from clients to get a report of all nodes
in the cluster from the <code>ResourceManager</code>.</p>
The request will ask for all nodes in the given {@link NodeState}s.
@see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
<class name="GetClusterNodesResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetClusterNodesResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getNodeReports" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
@return <code>NodeReport</code> for all nodes in the cluster]]>
</doc>
</method>
<doc>
<![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
requesting a {@link NodeReport} for all nodes.</p>
<p>The <code>NodeReport</code> contains per-node information such as
available resources, number of containers, tracking url, rack name, health
status etc.
@see NodeReport
@see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
<class name="GetContainerReportRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainerReportRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
</method>
<method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ContainerId</code> of the Container.
@return <code>ContainerId</code> of the Container]]>
</doc>
</method>
<method name="setContainerId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
<doc>
<![CDATA[Set the <code>ContainerId</code> of the container
@param containerId
<code>ContainerId</code> of the container]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The request sent by a client to the <code>ResourceManager</code> to get an
{@link ContainerReport} for a container.
</p>]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
<class name="GetContainerReportResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainerReportResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
</method>
<method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ContainerReport</code> for the container.
@return <code>ContainerReport</code> for the container]]>
</doc>
</method>
<method name="setContainerReport"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>ResourceManager</code> to a client requesting
a container report.
</p>
<p>
The response includes a {@link ContainerReport} which has details of a
container.
</p>]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
<class name="GetContainersRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainersRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
</method>
<method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
@return <code>ApplicationAttemptId</code> of an application attempt]]>
</doc>
</method>
<method name="setApplicationAttemptId"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
<doc>
<![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
@param applicationAttemptId
<code>ApplicationAttemptId</code> of an application attempt]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The request from clients to get a list of container reports, which belong to
an application attempt from the <code>ResourceManager</code>.
</p>
@see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
<class name="GetContainersResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainersResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="containers" type="java.util.List"/>
</method>
<method name="getContainerList" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
application attempt.
@return a list of <code>ContainerReport</code> for all the containers of an
application attempt]]>
</doc>
</method>
<method name="setContainerList"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="containers" type="java.util.List"/>
<doc>
<![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
application attempt.
@param containers
a list of <code>ContainerReport</code> for all the containers of
an application attempt]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>ResourceManager</code> to a client requesting
a list of {@link ContainerReport} for containers.
</p>
<p>
The <code>ContainerReport</code> for each container includes the container
details.
</p>
@see ContainerReport
@see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
<class name="GetContainerStatusesRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainerStatusesRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerIds" type="java.util.List"/>
</method>
<method name="getContainerIds" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
the <code>ContainerStatus</code>.
@return the list of <code>ContainerId</code>s of containers for which to
obtain the <code>ContainerStatus</code>.]]>
</doc>
</method>
<method name="setContainerIds"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="containerIds" type="java.util.List"/>
<doc>
<![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
the <code>ContainerStatus</code>
@param containerIds
a list of <code>ContainerId</code>s of containers for which to
obtain the <code>ContainerStatus</code>]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The request sent by the <code>ApplicationMaster</code> to the
<code>NodeManager</code> to get {@link ContainerStatus} of requested
containers.
</p>
@see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
<class name="GetContainerStatusesResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetContainerStatusesResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getContainerStatuses" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
@return <code>ContainerStatus</code>es of the requested containers.]]>
</doc>
</method>
<method name="getFailedRequests" return="java.util.Map"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the containerId-to-exception map in which the exception indicates error
from per container for failed requests]]>
</doc>
</method>
<doc>
<![CDATA[<p>
The response sent by the <code>NodeManager</code> to the
<code>ApplicationMaster</code> when asked to obtain the
<code>ContainerStatus</code> of requested containers.
</p>
@see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
<class name="GetDelegationTokenRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetDelegationTokenRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
</method>
<method name="getRenewer" return="java.lang.String"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setRenewer"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
</method>
<doc>
<![CDATA[The request issued by the client to get a delegation token from
the {@code ResourceManager}.
for more information.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
<class name="GetDelegationTokenResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetDelegationTokenResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The Delegation tokens have a identifier which maps to
{@link AbstractDelegationTokenIdentifier}.]]>
</doc>
</method>
<doc>
<![CDATA[Response to a {@link GetDelegationTokenRequest} request
from the client. The response contains the token that
can be used by the containers to talk to ClientRMService.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
<class name="GetNewApplicationRequest" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetNewApplicationRequest"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
submitting an application.</p>
<p>Currently, this is empty.</p>
@see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
<!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
<class name="GetNewApplicationResponse" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GetNewApplicationResponse"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name=