YARN-1453. [JDK8] Fix Javadoc errors caused by incorrect or illegal tags in doc comments. Contributed by Akira AJISAKA, Andrew Purtell, and Allen Wittenauer.
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/3da9a97c Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/3da9a97c Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/3da9a97c Branch: refs/heads/YARN-2928 Commit: 3da9a97cfbcc3a1c50aaf85b1a129d4d269cd5fd Parents: 3ff1ba2 Author: Tsuyoshi Ozawa <[email protected]> Authored: Mon Mar 16 23:19:05 2015 +0900 Committer: Tsuyoshi Ozawa <[email protected]> Committed: Mon Mar 16 23:19:05 2015 +0900 ---------------------------------------------------------------------- hadoop-yarn-project/CHANGES.txt | 3 + .../yarn/api/ApplicationBaseProtocol.java | 44 ++++--------- .../yarn/api/ApplicationClientProtocol.java | 3 - .../api/protocolrecords/AllocateRequest.java | 25 ++++--- .../api/protocolrecords/AllocateResponse.java | 68 ++++++++++---------- .../FinishApplicationMasterRequest.java | 25 ++++--- .../FinishApplicationMasterResponse.java | 7 +- .../protocolrecords/GetApplicationsRequest.java | 1 - .../GetClusterMetricsResponse.java | 4 +- .../GetContainerStatusesRequest.java | 2 - .../GetContainerStatusesResponse.java | 2 - .../protocolrecords/GetQueueInfoRequest.java | 2 +- .../protocolrecords/GetQueueInfoResponse.java | 11 ++-- .../KillApplicationResponse.java | 9 ++- .../RegisterApplicationMasterRequest.java | 33 +++++----- .../RegisterApplicationMasterResponse.java | 11 ++-- .../protocolrecords/StartContainerRequest.java | 9 +-- .../api/records/ApplicationAttemptReport.java | 23 +++---- .../yarn/api/records/ApplicationReport.java | 47 +++++++------- .../records/ApplicationSubmissionContext.java | 50 +++++++------- .../hadoop/yarn/api/records/Container.java | 49 +++++++------- .../api/records/ContainerLaunchContext.java | 35 +++++----- .../yarn/api/records/ContainerReport.java | 29 ++++----- .../yarn/api/records/ContainerStatus.java | 21 +++--- .../yarn/api/records/LocalResourceType.java | 32 ++++----- .../api/records/LocalResourceVisibility.java | 31 +++++---- .../yarn/api/records/LogAggregationContext.java | 39 ++++++----- .../hadoop/yarn/api/records/NodeReport.java | 25 ++++--- .../yarn/api/records/PreemptionMessage.java | 32 ++++----- .../hadoop/yarn/api/records/QueueACL.java | 13 ++-- .../hadoop/yarn/api/records/QueueInfo.java | 25 ++++--- .../hadoop/yarn/api/records/QueueState.java | 15 ++--- .../yarn/api/records/ReservationRequest.java | 17 ++--- .../records/ReservationRequestInterpreter.java | 38 +++++------ .../yarn/api/records/ResourceRequest.java | 51 +++++++-------- .../hadoop/yarn/conf/YarnConfiguration.java | 5 +- .../UpdateNodeResourceRequest.java | 4 +- .../hadoop/yarn/client/api/AHSClient.java | 24 +++---- .../hadoop/yarn/client/api/AMRMClient.java | 4 +- .../apache/hadoop/yarn/client/api/NMClient.java | 4 +- .../hadoop/yarn/client/api/NMTokenCache.java | 58 ++++++++--------- .../hadoop/yarn/client/api/YarnClient.java | 23 ++++--- .../nodelabels/CommonNodeLabelsManager.java | 6 +- .../hadoop/yarn/nodelabels/NodeLabelsStore.java | 3 +- .../server/security/ApplicationACLsManager.java | 1 - .../apache/hadoop/yarn/util/StringHelper.java | 6 +- .../org/apache/hadoop/yarn/webapp/WebApps.java | 4 +- .../registry/client/binding/RegistryUtils.java | 8 +-- .../client/impl/RegistryOperationsClient.java | 2 +- .../client/impl/zk/ZookeeperConfigOptions.java | 3 +- .../server/services/MicroZookeeperService.java | 10 +-- .../registry/server/services/package-info.java | 9 ++- ...TimelineAuthenticationFilterInitializer.java | 13 ++-- .../org/apache/hadoop/yarn/lib/ZKClient.java | 2 +- .../RegisterNodeManagerRequest.java | 3 +- .../server/api/records/NodeHealthStatus.java | 24 ++++--- .../server/nodemanager/ContainerExecutor.java | 8 ++- .../util/NodeManagerHardwareUtils.java | 8 +-- .../rmapp/attempt/RMAppAttempt.java | 11 ++-- .../scheduler/SchedulerNode.java | 2 +- .../scheduler/SchedulerUtils.java | 3 +- .../fair/policies/ComputeFairShares.java | 19 +++--- .../security/DelegationTokenRenewer.java | 2 - .../yarn/server/webproxy/ProxyUriUtils.java | 2 +- 64 files changed, 517 insertions(+), 585 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/CHANGES.txt ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/CHANGES.txt b/hadoop-yarn-project/CHANGES.txt index bcab88c..26ef7d3 100644 --- a/hadoop-yarn-project/CHANGES.txt +++ b/hadoop-yarn-project/CHANGES.txt @@ -769,6 +769,9 @@ Release 2.7.0 - UNRELEASED YARN-3171. Sort by Application id, AppAttempt and ContainerID doesn't work in ATS / RM web ui. (Naganarasimha G R via xgong) + YARN-1453. [JDK8] Fix Javadoc errors caused by incorrect or illegal tags in + doc comments. (Akira AJISAKA, Andrew Purtell, and Allen Wittenauer via ozawa) + Release 2.6.0 - 2014-11-18 INCOMPATIBLE CHANGES http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java index 2a8a283..8234c2f 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java @@ -65,41 +65,31 @@ import org.apache.hadoop.yarn.exceptions.YarnException; public interface ApplicationBaseProtocol { /** - * <p> * The interface used by clients to get a report of an Application from the * <code>ResourceManager</code> or <code>ApplicationHistoryServer</code>. - * </p> - * * <p> * The client, via {@link GetApplicationReportRequest} provides the * {@link ApplicationId} of the application. - * </p> - * * <p> * In secure mode,the <code>ResourceManager</code> or * <code>ApplicationHistoryServer</code> verifies access to the application, * queue etc. before accepting the request. - * </p> - * * <p> * The <code>ResourceManager</code> or <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> + * <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 @@ -148,40 +138,30 @@ public interface ApplicationBaseProtocol { IOException; /** - * <p> * The interface used by clients to get a report of an Application Attempt * from the <code>ResourceManager</code> or * <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>ResourceManager</code> or * <code>ApplicationHistoryServer</code> verifies access to the method before * accepting the request. - * </p> - * * <p> * The <code>ResourceManager</code> or <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> + * <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 http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java index 0a7d415..8b9937b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java @@ -135,9 +135,6 @@ public interface ApplicationClientProtocol extends ApplicationBaseProtocol { * @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) */ @Public http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java index 62316a6..2458d9b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java @@ -35,19 +35,18 @@ import org.apache.hadoop.yarn.util.Records; * <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> + * <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) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java index 46ac642..c4fdb79 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java @@ -39,27 +39,27 @@ import org.apache.hadoop.yarn.api.records.Token; import org.apache.hadoop.yarn.util.Records; /** - * <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> + * 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) */ @@ -220,16 +220,16 @@ public abstract class AllocateResponse { public abstract void setNumClusterNodes(int numNodes); /** - * <p>Get the description of containers owned by the AM, but requested back by + * 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. + * 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> + * 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> + * over some duration may be forcibly killed by the RM. * * @return A specification of the resources to reclaim from this AM. */ @@ -242,15 +242,17 @@ public abstract class AllocateResponse { public abstract void setPreemptionMessage(PreemptionMessage request); /** - * <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> + * 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> - * <p>AM will receive one NMToken per NM irrespective of the number of containers + * 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.<p> + * new token for the same NM. */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java index 15c3680..cbbe9c5 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java @@ -25,19 +25,18 @@ import org.apache.hadoop.yarn.api.records.FinalApplicationStatus; import org.apache.hadoop.yarn.util.Records; /** - * <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> + * 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) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java index 8de2c73..6647a10 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java @@ -26,22 +26,19 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <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> + * <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 . + * the application. * * @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java index 7fc58d6..35392e4 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java @@ -34,7 +34,6 @@ import org.apache.hadoop.yarn.util.Records; * <p>The request from clients to get a report of Applications * in the cluster from the <code>ResourceManager</code>.</p> * - * * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) */ @Public http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java index 6329aac..18a0807 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java @@ -27,8 +27,8 @@ import org.apache.hadoop.yarn.api.records.YarnClusterMetrics; import org.apache.hadoop.yarn.util.Records; /** - * <p>The response sent by the <code>ResourceManager</code> to a client - * requesting cluster metrics.<p> + * The response sent by the <code>ResourceManager</code> to a client + * requesting cluster metrics. * * @see YarnClusterMetrics * @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java index f9f77a3..60c63ca 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java @@ -28,11 +28,9 @@ import org.apache.hadoop.yarn.api.records.ContainerStatus; import org.apache.hadoop.yarn.util.Records; /** - * <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) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java index b0a0f0e..68e6a8c 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java @@ -32,11 +32,9 @@ import org.apache.hadoop.yarn.api.records.SerializedException; import org.apache.hadoop.yarn.util.Records; /** - * <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) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java index df3342f..0e33e21 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java @@ -63,7 +63,7 @@ public abstract class GetQueueInfoRequest { public abstract void setQueueName(String queueName); /** - * Is information about <em>active applications<e/m> required? + * Is information about <em>active applications</em> required? * @return <code>true</code> if applications' information is to be included, * else <code>false</code> */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java index ea6cb7b..b97a5a3 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java @@ -27,12 +27,11 @@ import org.apache.hadoop.yarn.api.records.QueueInfo; import org.apache.hadoop.yarn.util.Records; /** - * <p>The response sent by the <code>ResourceManager</code> to a client - * requesting information about queues in the system.</p> - * - * <p>The response includes a {@link QueueInfo} which has details such as - * queue name, used/total capacities, running applications, child queues etc - * .</p> + * The response sent by the {@code ResourceManager} to a client + * requesting information about queues in the system. + * <p> + * The response includes a {@link QueueInfo} which has details such as + * queue name, used/total capacities, running applications, child queues etc. * * @see QueueInfo * @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java index 77bb71d..7225bf5 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java @@ -26,21 +26,20 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p> * The response sent by the <code>ResourceManager</code> to the client aborting * a submitted application. - * </p> * <p> * The response, includes: * <ul> - * <li>A flag which indicates that the process of killing the application is - * completed or not.</li> + * <li> + * A flag which indicates that the process of killing the application is + * completed or not. + * </li> * </ul> * Note: user is recommended to wait until this flag becomes true, otherwise if * the <code>ResourceManager</code> crashes before the process of killing the * application is completed, the <code>ResourceManager</code> may retry this * application on recovery. - * </p> * * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java index 6b01854..395e190 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java @@ -24,16 +24,15 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p>The request sent by the <code>ApplicationMaster</code> to - * <code>ResourceManager</code> on registration.</p> - * - * <p>The registration includes details such as: - * <ul> - * <li>Hostname on which the AM is running.</li> - * <li>RPC Port</li> - * <li>Tracking URL</li> - * </ul> - * </p> + * The request sent by the {@code ApplicationMaster} to {@code ResourceManager} + * on registration. + * <p> + * The registration includes details such as: + * <ul> + * <li>Hostname on which the AM is running.</li> + * <li>RPC Port</li> + * <li>Tracking URL</li> + * </ul> * * @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest) */ @@ -83,20 +82,20 @@ public abstract class RegisterApplicationMasterRequest { public abstract void setHost(String host); /** - * Get the <em>RPC port</em> on which the <code>ApplicationMaster</code> - * is responding. - * @return the <em>RPC port<em> on which the <code>ApplicationMaster</code> is - * responding + * Get the <em>RPC port</em> on which the {@code ApplicationMaster} is + * responding. + * @return the <em>RPC port</em> on which the {@code ApplicationMaster} + * is responding */ @Public @Stable public abstract int getRpcPort(); /** - * Set the <em>RPC port<em> on which the <code>ApplicationMaster</code> is + * Set the <em>RPC port</em> on which the {@code ApplicationMaster} is * responding. - * @param port <em>RPC port<em> on which the <code>ApplicationMaster</code> is - * responding + * @param port <em>RPC port</em> on which the {@code ApplicationMaster} + * is responding */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java index 33daf28..1a51ba6 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java @@ -36,16 +36,15 @@ import org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes; import org.apache.hadoop.yarn.util.Records; /** - * <p>The response sent by the <code>ResourceManager</code> to a new - * <code>ApplicationMaster</code> on registration.</p> - * - * <p>The response contains critical details such as: + * The response sent by the {@code ResourceManager} to a new + * {@code ApplicationMaster} on registration. + * <p> + * The response contains critical details such as: * <ul> * <li>Maximum capability for allocated resources in the cluster.</li> - * <li><code>ApplicationACL</code>s for the application.</li> + * <li>{@code ApplicationACL}s for the application.</li> * <li>ClientToAMToken master key.</li> * </ul> - * </p> * * @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java index 1dcefb2..50179a9 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java @@ -74,10 +74,11 @@ public abstract class StartContainerRequest { public abstract void setContainerLaunchContext(ContainerLaunchContext context); /** - * <p>Get the container token to be used for authorization during starting - * container.</p> - * <p>Note: {@link NMToken} will be used for authenticating communication with </code> - * NodeManager</code>.</p> + * Get the container token to be used for authorization during starting + * container. + * <p> + * Note: {@link NMToken} will be used for authenticating communication with + * {@code NodeManager}. * @return the container token to be used for authorization during starting * container. * @see NMToken http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java index 53c18ae..b7f9c1b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java @@ -24,24 +24,19 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p> - * <code>ApplicationAttemptReport</code> is a report of an application attempt. - * </p> - * + * {@code ApplicationAttemptReport} is a report of an application attempt. * <p> * It includes details such as: * <ul> - * <li>{@link ApplicationAttemptId} of the application.</li> - * <li>Host on which the <code>ApplicationMaster</code> of this attempt is - * running.</li> - * <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li> - * <li>Tracking URL.</li> - * <li>Diagnostic information in case of errors.</li> - * <li>{@link YarnApplicationAttemptState} of the application attempt.</li> - * <li>{@link ContainerId} of the master Container.</li> + * <li>{@link ApplicationAttemptId} of the application.</li> + * <li>Host on which the <code>ApplicationMaster</code> of this attempt is + * running.</li> + * <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li> + * <li>Tracking URL.</li> + * <li>Diagnostic information in case of errors.</li> + * <li>{@link YarnApplicationAttemptState} of the application attempt.</li> + * <li>{@link ContainerId} of the master Container.</li> * </ul> - * </p> - * */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java index 412c22b..ff4fb52 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java @@ -28,23 +28,22 @@ import org.apache.hadoop.yarn.util.Records; import java.util.Set; /** - * <p><code>ApplicationReport</code> is a report of an application.</p> - * - * <p>It includes details such as: - * <ul> - * <li>{@link ApplicationId} of the application.</li> - * <li>Applications user.</li> - * <li>Application queue.</li> - * <li>Application name.</li> - * <li>Host on which the <code>ApplicationMaster</code> is running.</li> - * <li>RPC port of the <code>ApplicationMaster</code>.</li> - * <li>Tracking URL.</li> - * <li>{@link YarnApplicationState} of the application.</li> - * <li>Diagnostic information in case of errors.</li> - * <li>Start time of the application.</li> - * <li>Client {@link Token} of the application (if security is enabled).</li> - * </ul> - * </p> + * {@code ApplicationReport} is a report of an application. + * <p> + * It includes details such as: + * <ul> + * <li>{@link ApplicationId} of the application.</li> + * <li>Applications user.</li> + * <li>Application queue.</li> + * <li>Application name.</li> + * <li>Host on which the <code>ApplicationMaster</code> is running.</li> + * <li>RPC port of the <code>ApplicationMaster</code>.</li> + * <li>Tracking URL.</li> + * <li>{@link YarnApplicationState} of the application.</li> + * <li>Diagnostic information in case of errors.</li> + * <li>Start time of the application.</li> + * <li>Client {@link Token} of the application (if security is enabled).</li> + * </ul> * * @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest) */ @@ -341,20 +340,20 @@ public abstract class ApplicationReport { /** * Get the AMRM token of the application. - * <p/> + * <p> * The AMRM token is required for AM to RM scheduling operations. For * managed Application Masters Yarn takes care of injecting it. For unmanaged * Applications Masters, the token must be obtained via this method and set * in the {@link org.apache.hadoop.security.UserGroupInformation} of the * current user. - * <p/> + * <p> * The AMRM token will be returned only if all the following conditions are * met: - * <li> - * <ul>the requester is the owner of the ApplicationMaster</ul> - * <ul>the application master is an unmanaged ApplicationMaster</ul> - * <ul>the application master is in ACCEPTED state</ul> - * </li> + * <ul> + * <li>the requester is the owner of the ApplicationMaster</li> + * <li>the application master is an unmanaged ApplicationMaster</li> + * <li>the application master is in ACCEPTED state</li> + * </ul> * Else this method returns NULL. * * @return the AM to RM token if available. http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java index c4014fc..21cd1bb 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java @@ -33,32 +33,34 @@ import org.apache.hadoop.yarn.conf.YarnConfiguration; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>ApplicationSubmissionContext</code> represents all of the - * information needed by the <code>ResourceManager</code> to launch - * the <code>ApplicationMaster</code> for an application.</p> - * - * <p>It includes details such as: - * <ul> - * <li>{@link ApplicationId} of the application.</li> - * <li>Application user.</li> - * <li>Application name.</li> - * <li>{@link Priority} of the application.</li> - * <li> - * {@link ContainerLaunchContext} of the container in which the - * <code>ApplicationMaster</code> is executed. - * </li> - * <li>maxAppAttempts. The maximum number of application attempts. + * {@code ApplicationSubmissionContext} represents all of the + * information needed by the {@code ResourceManager} to launch + * the {@code ApplicationMaster} for an application. + * <p> + * It includes details such as: + * <ul> + * <li>{@link ApplicationId} of the application.</li> + * <li>Application user.</li> + * <li>Application name.</li> + * <li>{@link Priority} of the application.</li> + * <li> + * {@link ContainerLaunchContext} of the container in which the + * <code>ApplicationMaster</code> is executed. + * </li> + * <li> + * maxAppAttempts. The maximum number of application attempts. * It should be no larger than the global number of max attempts in the - * Yarn configuration.</li> - * <li>attemptFailuresValidityInterval. The default value is -1. - * when attemptFailuresValidityInterval in milliseconds is set to > 0, - * the failure number will no take failures which happen out of the - * validityInterval into failure count. If failure count reaches to - * maxAppAttempts, the application will be failed. - * </li> + * Yarn configuration. + * </li> + * <li> + * attemptFailuresValidityInterval. The default value is -1. + * when attemptFailuresValidityInterval in milliseconds is set to + * {@literal >} 0, the failure number will no take failures which happen + * out of the validityInterval into failure count. If failure count + * reaches to maxAppAttempts, the application will be failed. + * </li> * <li>Optional, application-specific {@link LogAggregationContext}</li> - * </ul> - * </p> + * </ul> * * @see ContainerLaunchContext * @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java index 279f127..38fa8b9 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java @@ -27,34 +27,31 @@ import org.apache.hadoop.yarn.api.ContainerManagementProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>Container</code> represents an allocated resource in the cluster. - * </p> - * - * <p>The <code>ResourceManager</code> is the sole authority to allocate any - * <code>Container</code> to applications. The allocated <code>Container</code> + * {@code Container} represents an allocated resource in the cluster. + * <p> + * The {@code ResourceManager} is the sole authority to allocate any + * {@code Container} to applications. The allocated {@code Container} * is always on a single node and has a unique {@link ContainerId}. It has - * a specific amount of {@link Resource} allocated.</p> - * - * <p>It includes details such as: - * <ul> - * <li>{@link ContainerId} for the container, which is globally unique.</li> - * <li> - * {@link NodeId} of the node on which it is allocated. - * </li> - * <li>HTTP uri of the node.</li> - * <li>{@link Resource} allocated to the container.</li> - * <li>{@link Priority} at which the container was allocated.</li> - * <li> - * Container {@link Token} of the container, used to securely verify - * authenticity of the allocation. - * </li> - * </ul> - * </p> + * a specific amount of {@link Resource} allocated. + * <p> + * It includes details such as: + * <ul> + * <li>{@link ContainerId} for the container, which is globally unique.</li> + * <li> + * {@link NodeId} of the node on which it is allocated. + * </li> + * <li>HTTP uri of the node.</li> + * <li>{@link Resource} allocated to the container.</li> + * <li>{@link Priority} at which the container was allocated.</li> + * <li> + * Container {@link Token} of the container, used to securely verify + * authenticity of the allocation. + * </li> + * </ul> * - * <p>Typically, an <code>ApplicationMaster</code> receives the - * <code>Container</code> from the <code>ResourceManager</code> during - * resource-negotiation and then talks to the <code>NodeManager</code> to - * start/stop containers.</p> + * Typically, an {@code ApplicationMaster} receives the {@code Container} + * from the {@code ResourceManager} during resource-negotiation and then + * talks to the {@code NodeManager} to start/stop containers. * * @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest) * @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java index a648fef..932945b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java @@ -30,24 +30,23 @@ import org.apache.hadoop.yarn.server.api.AuxiliaryService; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>ContainerLaunchContext</code> represents all of the information - * needed by the <code>NodeManager</code> to launch a container.</p> - * - * <p>It includes details such as: - * <ul> - * <li>{@link ContainerId} of the container.</li> - * <li>{@link Resource} allocated to the container.</li> - * <li>User to whom the container is allocated.</li> - * <li>Security tokens (if security is enabled).</li> - * <li> - * {@link LocalResource} necessary for running the container such - * as binaries, jar, shared-objects, side-files etc. - * </li> - * <li>Optional, application-specific binary service data.</li> - * <li>Environment variables for the launched process.</li> - * <li>Command to launch the container.</li> - * </ul> - * </p> + * {@code ContainerLaunchContext} represents all of the information + * needed by the {@code NodeManager} to launch a container. + * <p> + * It includes details such as: + * <ul> + * <li>{@link ContainerId} of the container.</li> + * <li>{@link Resource} allocated to the container.</li> + * <li>User to whom the container is allocated.</li> + * <li>Security tokens (if security is enabled).</li> + * <li> + * {@link LocalResource} necessary for running the container such + * as binaries, jar, shared-objects, side-files etc. + * </li> + * <li>Optional, application-specific binary service data.</li> + * <li>Environment variables for the launched process.</li> + * <li>Command to launch the container.</li> + * </ul> * * @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java index 72b8edf..11d7bca 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java @@ -24,27 +24,22 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p> - * <code>ContainerReport</code> is a report of an container. - * </p> - * + * {@code ContainerReport} is a report of an container. * <p> * It includes details such as: * <ul> - * <li>{@link ContainerId} of the container.</li> - * <li>Allocated Resources to the container.</li> - * <li>Assigned Node id.</li> - * <li>Assigned Priority.</li> - * <li>Creation Time.</li> - * <li>Finish Time.</li> - * <li>Container Exit Status.</li> - * <li>{@link ContainerState} of the container.</li> - * <li>Diagnostic information in case of errors.</li> - * <li>Log URL.</li> - * <li>nodeHttpAddress</li> + * <li>{@link ContainerId} of the container.</li> + * <li>Allocated Resources to the container.</li> + * <li>Assigned Node id.</li> + * <li>Assigned Priority.</li> + * <li>Creation Time.</li> + * <li>Finish Time.</li> + * <li>Container Exit Status.</li> + * <li>{@link ContainerState} of the container.</li> + * <li>Diagnostic information in case of errors.</li> + * <li>Log URL.</li> + * <li>nodeHttpAddress</li> * </ul> - * </p> - * */ @Public http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java index 574373c..5ccf6dc 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java @@ -25,17 +25,16 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>ContainerStatus</code> represents the current status of a - * <code>Container</code>.</p> - * - * <p>It provides details such as: - * <ul> - * <li><code>ContainerId</code> of the container.</li> - * <li><code>ContainerState</code> of the container.</li> - * <li><em>Exit status</em> of a completed container.</li> - * <li><em>Diagnostic</em> message for a failed container.</li> - * </ul> - * </p> + * {@code ContainerStatus} represents the current status of a + * {@code Container}. + * <p> + * It provides details such as: + * <ul> + * <li>{@code ContainerId} of the container.</li> + * <li>{@code ContainerState} of the container.</li> + * <li><em>Exit status</em> of a completed container.</li> + * <li><em>Diagnostic</em> message for a failed container.</li> + * </ul> */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java index d1aa45b..1552cdf 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java @@ -23,22 +23,22 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ContainerManagementProtocol; /** - * <p><code>LocalResourceType</code> specifies the <em>type</em> - * of a resource localized by the <code>NodeManager</code>.</p> - * - * <p>The <em>type</em> can be one of: - * <ul> - * <li> - * {@link #FILE} - Regular file i.e. uninterpreted bytes. - * </li> - * <li> - * {@link #ARCHIVE} - Archive, which is automatically unarchived by the - * <code>NodeManager</code>. - * </li> - * <li> - * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. - * </ul> - * </p> + * {@code LocalResourceType} specifies the <em>type</em> + * of a resource localized by the {@code NodeManager}. + * <p> + * The <em>type</em> can be one of: + * <ul> + * <li> + * {@link #FILE} - Regular file i.e. uninterpreted bytes. + * </li> + * <li> + * {@link #ARCHIVE} - Archive, which is automatically unarchived by the + * <code>NodeManager</code>. + * </li> + * <li> + * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. + * </li> + * </ul> * * @see LocalResource * @see ContainerLaunchContext http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java index d368bfb..2b71991 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java @@ -23,22 +23,21 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ContainerManagementProtocol; /** - * <p><code>LocalResourceVisibility</code> specifies the <em>visibility</em> - * of a resource localized by the <code>NodeManager</code>.</p> - * - * <p>The <em>visibility</em> can be one of: - * <ul> - * <li>{@link #PUBLIC} - Shared by all users on the node.</li> - * <li> - * {@link #PRIVATE} - Shared among all applications of the - * <em>same user</em> on the node. - * </li> - * <li> - * {@link #APPLICATION} - Shared only among containers of the - * <em>same application</em> on the node. - * </li> - * </ul> - * </p> + * {@code LocalResourceVisibility} specifies the <em>visibility</em> + * of a resource localized by the {@code NodeManager}. + * <p> + * The <em>visibility</em> can be one of: + * <ul> + * <li>{@link #PUBLIC} - Shared by all users on the node.</li> + * <li> + * {@link #PRIVATE} - Shared among all applications of the + * <em>same user</em> on the node. + * </li> + * <li> + * {@link #APPLICATION} - Shared only among containers of the + * <em>same application</em> on the node. + * </li> + * </ul> * * @see LocalResource * @see ContainerLaunchContext http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java index e582d2c..9383004 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java @@ -24,30 +24,37 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>LogAggregationContext</code> represents all of the - * information needed by the <code>NodeManager</code> to handle - * the logs for an application.</p> - * - * <p>It includes details such as: - * <ul> - * <li>includePattern. It uses Java Regex to filter the log files + * {@code LogAggregationContext} represents all of the + * information needed by the {@code NodeManager} to handle + * the logs for an application. + * <p> + * It includes details such as: + * <ul> + * <li> + * includePattern. It uses Java Regex to filter the log files * which match the defined include pattern and those log files - * will be uploaded when the application finishes. </li> - * <li>excludePattern. It uses Java Regex to filter the log files + * will be uploaded when the application finishes. + * </li> + * <li> + * excludePattern. It uses Java Regex to filter the log files * which match the defined exclude pattern and those log files * will not be uploaded when application finishes. If the log file * name matches both the include and the exclude pattern, this file - * will be excluded eventually</li> - * <li>rolledLogsIncludePattern. It uses Java Regex to filter the log files + * will be excluded eventually. + * </li> + * <li> + * rolledLogsIncludePattern. It uses Java Regex to filter the log files * which match the defined include pattern and those log files - * will be aggregated in a rolling fashion.</li> - * <li>rolledLogsExcludePattern. It uses Java Regex to filter the log files + * will be aggregated in a rolling fashion. + * </li> + * <li> + * rolledLogsExcludePattern. It uses Java Regex to filter the log files * which match the defined exclude pattern and those log files * will not be aggregated in a rolling fashion. If the log file * name matches both the include and the exclude pattern, this file - * will be excluded eventually</li> - * </ul> - * </p> + * will be excluded eventually. + * </li> + * </ul> * * @see ApplicationSubmissionContext */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java index 7ba866d..aac19bd 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java @@ -28,19 +28,18 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>NodeReport</code> is a summary of runtime information of a - * node in the cluster.</p> - * - * <p>It includes details such as: - * <ul> - * <li>{@link NodeId} of the node.</li> - * <li>HTTP Tracking URL of the node.</li> - * <li>Rack name for the node.</li> - * <li>Used {@link Resource} on the node.</li> - * <li>Total available {@link Resource} of the node.</li> - * <li>Number of running containers on the node.</li> - * </ul> - * </p> + * {@code NodeReport} is a summary of runtime information of a node + * in the cluster. + * <p> + * It includes details such as: + * <ul> + * <li>{@link NodeId} of the node.</li> + * <li>HTTP Tracking URL of the node.</li> + * <li>Rack name for the node.</li> + * <li>Used {@link Resource} on the node.</li> + * <li>Total available {@link Resource} of the node.</li> + * <li>Number of running containers on the node.</li> + * </ul> * * @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest) */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java index 976d181..cdf34f8 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java @@ -24,36 +24,36 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p>A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by + * A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by * the RM to specify resources that the RM wants to reclaim from this - * <code>ApplicationMaster</code> (AM). The AM receives a {@link + * {@code ApplicationMaster} (AM). The AM receives a {@link * StrictPreemptionContract} message encoding which containers the platform may * forcibly kill, granting it an opportunity to checkpoint state or adjust its * execution plan. The message may also include a {@link PreemptionContract} * granting the AM more latitude in selecting which resources to return to the - * cluster.<p> - * - * <p>The AM should decode both parts of the message. The {@link + * cluster. + * <p> + * The AM should decode both parts of the message. The {@link * StrictPreemptionContract} specifies particular allocations that the RM * requires back. The AM can checkpoint containers' state, adjust its execution * plan to move the computation, or take no action and hope that conditions that - * caused the RM to ask for the container will change.<p> - * - * <p>In contrast, the {@link PreemptionContract} also includes a description of + * caused the RM to ask for the container will change. + * <p> + * In contrast, the {@link PreemptionContract} also includes a description of * resources with a set of containers. If the AM releases containers matching * that profile, then the containers enumerated in {@link - * PreemptionContract#getContainers()} may not be killed.<p> - * - * <p>Each preemption message reflects the RM's current understanding of the - * cluster state, so a request to return <emph>N</emph> containers may not + * PreemptionContract#getContainers()} may not be killed. + * <p> + * Each preemption message reflects the RM's current understanding of the + * cluster state, so a request to return <em>N</em> containers may not * reflect containers the AM is releasing, recently exited containers the RM has * yet to learn about, or new containers allocated before the message was * generated. Conversely, an RM may request a different profile of containers in - * subsequent requests.<p> - * - * <p>The policy enforced by the RM is part of the scheduler. Generally, only + * subsequent requests. + * <p> + * The policy enforced by the RM is part of the scheduler. Generally, only * containers that have been requested consistently should be killed, but the - * details are not specified.<p> + * details are not specified. */ @Public @Evolving http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java index c6777db..585faf8 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java @@ -23,18 +23,15 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ApplicationClientProtocol; /** - * <p> - * <code>QueueACL</code> enumerates the various ACLs for queues. - * </p> - * + * {@code QueueACL} enumerates the various ACLs for queues. * <p> * The ACL is one of: * <ul> - * <li>{@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the - * queue.</li> - * <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li> + * <li> + * {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue. + * </li> + * <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li> * </ul> - * </p> * * @see QueueInfo * @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java index d762b41..bee5275 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java @@ -29,19 +29,18 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p>QueueInfo is a report of the runtime information of the queue.</p> - * - * <p>It includes information such as: - * <ul> - * <li>Queue name.</li> - * <li>Capacity of the queue.</li> - * <li>Maximum capacity of the queue.</li> - * <li>Current capacity of the queue.</li> - * <li>Child queues.</li> - * <li>Running applications.</li> - * <li>{@link QueueState} of the queue.</li> - * </ul> - * </p> + * QueueInfo is a report of the runtime information of the queue. + * <p> + * It includes information such as: + * <ul> + * <li>Queue name.</li> + * <li>Capacity of the queue.</li> + * <li>Maximum capacity of the queue.</li> + * <li>Current capacity of the queue.</li> + * <li>Child queues.</li> + * <li>Running applications.</li> + * <li>{@link QueueState} of the queue.</li> + * </ul> * * @see QueueState * @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java index 01698de..2bc0407 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java @@ -23,14 +23,13 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ApplicationClientProtocol; /** - * <p>State of a Queue.</p> - * - * <p>A queue is in one of: - * <ul> - * <li>{@link #RUNNING} - normal state.</li> - * <li>{@link #STOPPED} - not accepting new application submissions. - * </ul> - * </p> + * State of a Queue. + * <p> + * A queue is in one of: + * <ul> + * <li>{@link #RUNNING} - normal state.</li> + * <li>{@link #STOPPED} - not accepting new application submissions.</li> + * </ul> * * @see QueueInfo * @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest) http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java index a4f0585..4ebe1c2 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java @@ -25,23 +25,18 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - * <p> * {@link ReservationRequest} represents the request made by an application to * the {@code ResourceManager} to reserve {@link Resource}s. - * </p> - * * <p> * It includes: * <ul> - * <li>{@link Resource} required for each request.</li> - * <li> - * Number of containers, of above specifications, which are required by the - * application.</li> - * <li> - * Concurrency that indicates the gang size of the request.</li> + * <li>{@link Resource} required for each request.</li> + * <li> + * Number of containers, of above specifications, which are required by the + * application. + * </li> + * <li>Concurrency that indicates the gang size of the request.</li> * </ul> - * </p> - * */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java index 1ee96c2..3b82626 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java @@ -33,14 +33,13 @@ public enum ReservationRequestInterpreter { * Requires that exactly ONE among the {@link ReservationRequest} submitted as * of a {@link ReservationDefinition} is satisfied to satisfy the overall * {@link ReservationDefinition}. - * + * <p> * WHEN TO USE THIS: This is useful when the user have multiple equivalent * ways to run an application, and wants to expose to the ReservationAgent - * such flexibility. For example an application could use one <32GB,16core> - * container for 10min, or 16 <2GB,1core> containers for 15min, the - * ReservationAgent will decide which one of the two it is best for the system - * to place. - * + * such flexibility. For example an application could use one + * {@literal <32GB,16core>} container for 10min, or 16 {@literal <2GB,1core>} + * containers for 15min, the ReservationAgent will decide which one of the + * two it is best for the system to place. */ R_ANY, @@ -49,16 +48,16 @@ public enum ReservationRequestInterpreter { * {@link ReservationDefinition} are satisfied for the overall * {@link ReservationDefinition} to be satisfied. No constraints are imposed * on the temporal ordering of the allocation used to satisfy the - * ResourceRequeusts. - * + * ResourceRequests. + * <p> * WHEN TO USE THIS: This is useful to capture a scenario in which the user * cares for multiple ReservationDefinition to be all accepted, or none. For - * example, a user might want a reservation R1: with 10 x <8GB,4core> for - * 10min, and a reservation R2: with 2 <1GB,1core> for 1h, and only if both - * are satisfied the workflow run in this reservation succeeds. The key - * differentiator from ALL and ORDER, ORDER_NO_GAP, is that ALL imposes no - * restrictions on the relative allocations used to place R1 and R2 above. - * + * example, a user might want a reservation R1: with 10 x + * {@literal <8GB,4core>} for 10min, and a reservation R2: + * with 2 {@literal <1GB,1core>} for 1h, and only if both are satisfied + * the workflow run in this reservation succeeds. The key differentiator + * from ALL and ORDER, ORDER_NO_GAP, is that ALL imposes no restrictions + * on the relative allocations used to place R1 and R2 above. */ R_ALL, @@ -73,15 +72,16 @@ public enum ReservationRequestInterpreter { * constraints are imposed on temporal gaps between subsequent allocations * (the last instant of the previous allocation can be an arbitrary long * period of time before the first instant of the subsequent allocation). - * + * <p> * WHEN TO USE THIS: Like ALL this requires all ReservationDefinitions to be * placed, but it also imposes a time ordering on the allocations used. This * is important if the ReservationDefinition(s) are used to describe a * workflow with inherent inter-stage dependencies. For example, a first job - * runs in a ReservaitonDefinition R1 (10 x <1GB,1core> for 20min), and its - * output is consumed by a second job described by a ReservationDefinition R2 - * (5 x <1GB,1core>) for 50min). R2 allocation cannot overlap R1, as R2 models - * a job depending on the output of the job modeled by R1. + * runs in a ReservaitonDefinition R1 (10 x {@literal <1GB,1core>} + * for 20min), and its output is consumed by a second job described by + * a ReservationDefinition R2 (5 x {@literal <1GB,1core>}) for 50min). + * R2 allocation cannot overlap R1, as R2 models a job depending on + * the output of the job modeled by R1. */ R_ORDER, http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java index 2f17ac9..790120a 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java @@ -27,31 +27,30 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - * <p><code>ResourceRequest</code> represents the request made by an - * application to the <code>ResourceManager</code> to obtain various - * <code>Container</code> allocations.</p> - * - * <p>It includes: - * <ul> - * <li>{@link Priority} of the request.</li> - * <li> - * The <em>name</em> of the machine or rack on which the allocation is - * desired. A special value of <em>*</em> signifies that - * <em>any</em> host/rack is acceptable to the application. - * </li> - * <li>{@link Resource} required for each request.</li> - * <li> - * Number of containers, of above specifications, which are required - * by the application. - * </li> - * <li> - * A boolean <em>relaxLocality</em> flag, defaulting to <code>true</code>, - * which tells the <code>ResourceManager</code> if the application wants - * locality to be loose (i.e. allows fall-through to rack or <em>any</em>) - * or strict (i.e. specify hard constraint on resource allocation). - * </li> - * </ul> - * </p> + * {@code ResourceRequest} represents the request made + * by an application to the {@code ResourceManager} + * to obtain various {@code Container} allocations. + * <p> + * It includes: + * <ul> + * <li>{@link Priority} of the request.</li> + * <li> + * The <em>name</em> of the machine or rack on which the allocation is + * desired. A special value of <em>*</em> signifies that + * <em>any</em> host/rack is acceptable to the application. + * </li> + * <li>{@link Resource} required for each request.</li> + * <li> + * Number of containers, of above specifications, which are required + * by the application. + * </li> + * <li> + * A boolean <em>relaxLocality</em> flag, defaulting to {@code true}, + * which tells the {@code ResourceManager} if the application wants + * locality to be loose (i.e. allows fall-through to rack or <em>any</em>) + * or strict (i.e. specify hard constraint on resource allocation). + * </li> + * </ul> * * @see Resource * @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest) @@ -267,7 +266,7 @@ public abstract class ResourceRequest implements Comparable<ResourceRequest> { /** * Set node label expression of this resource request. Now only support * specifying a single node label. In the future we will support more complex - * node label expression specification like AND(&&), OR(||), etc. + * node label expression specification like {@code AND(&&), OR(||)}, etc. * * Any please note that node label expression now can only take effect when * the resource request has resourceName = ANY http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java index 8c83fea..f40c999 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java @@ -733,8 +733,9 @@ public class YarnConfiguration extends Configuration { /** * How long to wait between aggregated log retention checks. If set to - * a value <= 0 then the value is computed as one-tenth of the log retention - * setting. Be careful set this too small and you will spam the name node. + * a value {@literal <=} 0 then the value is computed as one-tenth of the + * log retention setting. Be careful set this too small and you will spam + * the name node. */ public static final String LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS = YARN_PREFIX + "log-aggregation.retain-check-interval-seconds"; http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java index d1ab781..d540cce 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java @@ -54,7 +54,7 @@ public abstract class UpdateNodeResourceRequest { /** * Get the map from <code>NodeId</code> to <code>ResourceOption</code>. - * @return the map of <NodeId, ResourceOption> + * @return the map of {@code <NodeId, ResourceOption>} */ @Public @Evolving @@ -62,7 +62,7 @@ public abstract class UpdateNodeResourceRequest { /** * Set the map from <code>NodeId</code> to <code>ResourceOption</code>. - * @param nodeResourceMap the map of <NodeId, ResourceOption> + * @param nodeResourceMap the map of {@code <NodeId, ResourceOption>} */ @Public @Evolving http://git-wip-us.apache.org/repos/asf/hadoop/blob/3da9a97c/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java index b3c5308..b590a51 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java @@ -56,28 +56,22 @@ public abstract class AHSClient extends AbstractService { } /** - * <p> * Get a report of the given Application. - * </p> - * * <p> * In secure mode, <code>YARN</code> verifies access to the application, queue * etc. before accepting the request. - * </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> + * <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 appId * {@link ApplicationId} of the application that needs a report @@ -121,7 +115,7 @@ public abstract class AHSClient extends AbstractService { * a report * @return application attempt report * @throws YarnException - * @throws {@link ApplicationAttemptNotFoundException} if application attempt + * @throws ApplicationAttemptNotFoundException if application attempt * not found * @throws IOException */ @@ -157,7 +151,7 @@ public abstract class AHSClient extends AbstractService { * {@link ContainerId} of the container that needs a report * @return container report * @throws YarnException - * @throws {@link ContainerNotFoundException} if container not found + * @throws ContainerNotFoundException if container not found * @throws IOException */ public abstract ContainerReport getContainerReport(ContainerId containerId)
