http://git-wip-us.apache.org/repos/asf/hadoop/blob/03fc6b1b/hadoop-yarn-project/hadoop-yarn/dev-support/jdiff/Apache_Hadoop_YARN_API_2.7.2.xml ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/dev-support/jdiff/Apache_Hadoop_YARN_API_2.7.2.xml b/hadoop-yarn-project/hadoop-yarn/dev-support/jdiff/Apache_Hadoop_YARN_API_2.7.2.xml new file mode 100644 index 0000000..ff01b26 --- /dev/null +++ b/hadoop-yarn-project/hadoop-yarn/dev-support/jdiff/Apache_Hadoop_YARN_API_2.7.2.xml @@ -0,0 +1,13692 @@ +<?xml version="1.0" encoding="iso-8859-1" standalone="no"?> +<!-- Generated by the JDiff Javadoc doclet --> +<!-- (http://www.jdiff.org) --> +<!-- on Thu May 12 17:47:18 PDT 2016 --> + +<api + xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' + xsi:noNamespaceSchemaLocation='api.xsd' + name="hadoop-yarn-api 2.7.2" + jdversion="1.0.9"> + +<!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/vinodkv/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/vinodkv/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/vinodkv/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/Users/vinodkv/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-common-2.7.2 .jar:/Users/vinodkv/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/vinodkv/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/vinodkv/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/vinodkv/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/vinodkv/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/vinodkv/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/vinodkv/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/Users/vinodkv/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/vinodkv/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api- 2.1.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/vinodkv/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/vinodkv/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/vinodkv/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/vinodkv/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/vinodkv/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/vinodkv/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/vinodkv/.m2/repos itory/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/vinodkv/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/vinodkv/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/vinodkv/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core -asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/vinodkv/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/vinodkv/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/vinodkv/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/a pi-util-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/Users/vinodkv/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar:/Users/vinodkv/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/vinodkv/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/vinodkv/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.7.2.jar:/Library/Java/JavaVirtualMachines/jdk1.7 .0_45.jdk/Contents/Home/lib/tools.jar:/Users/vinodkv/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.7.2 --> +<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"> + <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/> + <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 + @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="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="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="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="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="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse" + 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.GetLabelsToNodesRequest"/> + <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 labels to nodes mappings + in existing cluster + </p> + + @param request + @return labels to nodes 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"> + <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/> + <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.ClientSCMProtocol --> + <interface name="ClientSCMProtocol" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse" + 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.UseSharedCacheResourceRequest"/> + <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 claim a resource with the + <code>SharedCacheManager.</code> The client uses a checksum to identify the + resource and an {@link ApplicationId} to identify which application will be + using the resource. + </p> + + <p> + The <code>SharedCacheManager</code> responds with whether or not the + resource exists in the cache. If the resource exists, a <code>Path</code> + to the resource in the shared cache is returned. If the resource does not + exist, the response is empty. + </p> + + @param request request to claim a resource in the shared cache + @return response indicating if the resource is already in the cache + @throws YarnException + @throws IOException]]> + </doc> + </method> + <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse" + 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.ReleaseSharedCacheResourceRequest"/> + <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 release a resource with the + <code>SharedCacheManager.</code> This method is called once an application + is no longer using a claimed resource in the shared cache. The client uses + a checksum to identify the resource and an {@link ApplicationId} to + identify which application is releasing the resource. + </p> + + <p> + Note: This method is an optimization and the client is not required to call + it for correctness. + </p> + + <p> + Currently the <code>SharedCacheManager</code> sends an empty response. + </p> + + @param request request to release a resource in the shared cache + @return (empty) response on releasing the resource + @throws YarnException + @throws IOException]]> + </doc> + </method> + <doc> + <![CDATA[<p> + The protocol between clients and the <code>SharedCacheManager</code> to claim + and release resources in the shared cache. + </p>]]> + </doc> + </interface> + <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol --> + <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB --> + <interface name="ClientSCMProtocolPB" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.hadoop.yarn.proto.ClientSCMProtocol.ClientSCMProtocolService.BlockingInterface"/> + </interface> + <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB --> + <!-- 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> + + @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[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> + 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. + + @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[Get the list of NMTokens required for communicating with NM. New NMTokens + issued only if + <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> + 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.]]> + </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[The response sent by the <code>ResourceManager</code> the + <code>ApplicationMaster</code> during resource negotiation. + <p> + The response, includes: + <ul> + <li>Response ID to track duplicate responses.</li> + <li> + An AMCommand sent by ResourceManager to let the + {@code ApplicationMaster} take some actions (resync, shutdown etc.). + </li> + <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> + + @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[The finalization request sent by the {@code ApplicationMaster} to + inform the {@code ResourceManager} about its completion. + <p> + The final request includes details such: + <ul> + <li>Final state of the {@code ApplicationMaster}</li> + <li> + Diagnostic information in case of failure of the + {@code ApplicationMaster} + </li> + <li>Tracking URL</li> + </ul> + + @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[The response sent by the <code>ResourceManager</code> to a + <code>ApplicationMaster</code> on it's completion. + <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="appli
<TRUNCATED> --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org
