Return-Path: X-Original-To: apmail-hadoop-common-commits-archive@www.apache.org Delivered-To: apmail-hadoop-common-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7128717535 for ; Mon, 16 Mar 2015 20:18:22 +0000 (UTC) Received: (qmail 5232 invoked by uid 500); 16 Mar 2015 20:18:10 -0000 Delivered-To: apmail-hadoop-common-commits-archive@hadoop.apache.org Received: (qmail 4866 invoked by uid 500); 16 Mar 2015 20:18:10 -0000 Mailing-List: contact common-commits-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-dev@hadoop.apache.org Delivered-To: mailing list common-commits@hadoop.apache.org Received: (qmail 2546 invoked by uid 99); 16 Mar 2015 20:18:09 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 16 Mar 2015 20:18:09 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 1FE32E1851; Mon, 16 Mar 2015 20:18:09 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: zhz@apache.org To: common-commits@hadoop.apache.org Date: Mon, 16 Mar 2015 20:18:35 -0000 Message-Id: In-Reply-To: <7ade8212df8b49c8abfe194b31fc165b@git.apache.org> References: <7ade8212df8b49c8abfe194b31fc165b@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [28/50] [abbrv] hadoop git commit: YARN-1453. [JDK8] Fix Javadoc errors caused by incorrect or illegal tags in doc comments. Contributed by Akira AJISAKA, Andrew Purtell, and Allen Wittenauer. 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/HDFS-7285 Commit: 3da9a97cfbcc3a1c50aaf85b1a129d4d269cd5fd Parents: 3ff1ba2 Author: Tsuyoshi Ozawa Authored: Mon Mar 16 23:19:05 2015 +0900 Committer: Tsuyoshi Ozawa 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 { /** - *

* The interface used by clients to get a report of an Application from the * ResourceManager or ApplicationHistoryServer. - *

- * *

* The client, via {@link GetApplicationReportRequest} provides the * {@link ApplicationId} of the application. - *

- * *

* In secure mode,the ResourceManager or * ApplicationHistoryServer verifies access to the application, * queue etc. before accepting the request. - *

- * *

* The ResourceManager or ApplicationHistoryServer * responds with a {@link GetApplicationReportResponse} which includes the * {@link ApplicationReport} for the application. - *

- * *

* If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

    - *
  • host - set to "N/A"
    • - *
  • RPC port - set to -1
    • - *
  • client token - set to "N/A"
    • - *
  • diagnostics - set to "N/A"
    • - *
  • tracking URL - set to "N/A"
    • - *
  • original tracking URL - set to "N/A"
    • - *
  • resource usage report - all values are -1
    • + *
  • host - set to "N/A"
    • + *
  • RPC port - set to -1
    • + *
  • client token - set to "N/A"
    • + *
  • diagnostics - set to "N/A"
    • + *
  • tracking URL - set to "N/A"
    • + *
  • original tracking URL - set to "N/A"
    • + *
  • resource usage report - all values are -1
    • *
- *

* * @param request * request for an application report @@ -148,40 +138,30 @@ public interface ApplicationBaseProtocol { IOException; /** - *

* The interface used by clients to get a report of an Application Attempt * from the ResourceManager or * ApplicationHistoryServer - *

- * *

* The client, via {@link GetApplicationAttemptReportRequest} provides the * {@link ApplicationAttemptId} of the application attempt. - *

- * *

* In secure mode,the ResourceManager or * ApplicationHistoryServer verifies access to the method before * accepting the request. - *

- * *

* The ResourceManager or ApplicationHistoryServer * responds with a {@link GetApplicationAttemptReportResponse} which includes * the {@link ApplicationAttemptReport} for the application attempt. - *

- * *

* If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

    - *
  • host
    • - *
  • RPC port
    • - *
  • client token
    • - *
  • diagnostics - set to "N/A"
    • - *
  • tracking URL
    • + *
  • host
    • + *
  • RPC port
    • + *
  • client token
    • + *
  • diagnostics - set to "N/A"
    • + *
  • tracking URL
    • *
- *

* * @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; * ResourceManager to obtain resources in the cluster.

* *

The request includes: - *

    - *
  • A response id to track duplicate responses.
    • - *
  • Progress information.
    • - *
  • - * A list of {@link ResourceRequest} to inform the - * ResourceManager about the application's - * resource requirements. - *
    • - *
  • - * A list of unused {@link Container} which are being returned. - *
    • - *
- *

+ *
    + *
  • A response id to track duplicate responses.
    • + *
  • Progress information.
    • + *
  • + * A list of {@link ResourceRequest} to inform the + * ResourceManager about the application's + * resource requirements. + *
    • + *
  • + * A list of unused {@link Container} which are being returned. + *
    • + *
* * @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; /** - *

The response sent by the ResourceManager the - * ApplicationMaster during resource negotiation.

- * - *

The response, includes: - *

    - *
  • Response ID to track duplicate responses.
    • - *
  • - * An AMCommand sent by ResourceManager to let the ApplicationMaster - * take some actions (resync, shutdown etc.). - *
  • A list of newly allocated {@link Container}.
    • - *
  • A list of completed {@link Container}s' statuses.
    • - *
  • - * The available headroom for resources in the cluster for the - * application. - *
    • - *
  • A list of nodes whose status has been updated.
    • - *
  • The number of available nodes in a cluster.
    • - *
  • A description of resources requested back by the cluster
    • - *
  • AMRMToken, if AMRMToken has been rolled over
    • - *
- *

+ * The response sent by the ResourceManager the + * ApplicationMaster during resource negotiation. + *

+ * The response, includes: + *

    + *
  • Response ID to track duplicate responses.
    • + *
  • + * An AMCommand sent by ResourceManager to let the + * {@code ApplicationMaster} take some actions (resync, shutdown etc.). + *
    • + *
  • A list of newly allocated {@link Container}.
    • + *
  • A list of completed {@link Container}s' statuses.
    • + *
  • + * The available headroom for resources in the cluster for the + * application. + *
    • + *
  • A list of nodes whose status has been updated.
    • + *
  • The number of available nodes in a cluster.
    • + *
  • A description of resources requested back by the cluster
    • + *
  • AMRMToken, if AMRMToken has been rolled over
    • + *
* * @see ApplicationMasterProtocol#allocate(AllocateRequest) */ @@ -220,16 +220,16 @@ public abstract class AllocateResponse { public abstract void setNumClusterNodes(int numNodes); /** - *

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.

- * - *

The message is a snapshot of the resources the RM wants back from the AM. + * elect to ignore them. + *

+ * 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 additional + * not interpret each message as a request for additional * resources on top of previous messages. Resources requested consistently - * over some duration may be forcibly killed by the RM.

+ * 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); /** - *

Get the list of NMTokens required for communicating with NM. New NMTokens - * issued only if

- *

1) AM is receiving first container on underlying NodeManager.
+ * Get the list of NMTokens required for communicating with NM. New NMTokens + * issued only if + *

+ * 1) AM is receiving first container on underlying NodeManager.
* OR
* 2) NMToken master key rolled over in ResourceManager and AM is getting new - * container on the same underlying NodeManager.

- *

AM will receive one NMToken per NM irrespective of the number of containers + * container on the same underlying NodeManager. + *

+ * 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.

+ * 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; /** - *

The finalization request sent by the ApplicationMaster to - * inform the ResourceManager about its completion.

- * - *

The final request includes details such: - *

    - *
  • Final state of the ApplicationMaster
    • - *
  • - * Diagnostic information in case of failure of the - * ApplicationMaster - *
    • - *
  • Tracking URL
    • - *
- *

+ * The finalization request sent by the {@code ApplicationMaster} to + * inform the {@code ResourceManager} about its completion. + *

+ * The final request includes details such: + *

    + *
  • Final state of the {@code ApplicationMaster}
    • + *
  • + * Diagnostic information in case of failure of the + * {@code ApplicationMaster} + *
    • + *
  • Tracking URL
    • + *
* * @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; /** - *

* The response sent by the ResourceManager to a * ApplicationMaster on it's completion. - *

- * *

* The response, includes: *

    *
  • A flag which indicates that the application has successfully unregistered * with the RM and the application can safely stop.
    • *
- *

+ *

* 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; *

The request from clients to get a report of Applications * in the cluster from the ResourceManager.

* - * * @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; /** - *

The response sent by the ResourceManager to a client - * requesting cluster metrics.

+ * The response sent by the ResourceManager 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; /** - *

* The request sent by the ApplicationMaster to the * NodeManager to get {@link ContainerStatus} of requested * containers. - *

* * @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; /** - *

* The response sent by the NodeManager to the * ApplicationMaster when asked to obtain the * ContainerStatus of requested containers. - *

* * @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 active applications required? + * Is information about active applications required? * @return true if applications' information is to be included, * else false */ 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; /** - *

The response sent by the ResourceManager to a client - * requesting information about queues in the system.

- * - *

The response includes a {@link QueueInfo} which has details such as - * queue name, used/total capacities, running applications, child queues etc - * .

+ * The response sent by the {@code ResourceManager} to a client + * requesting information about queues in the system. + *

+ * 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; /** - *

* The response sent by the ResourceManager to the client aborting * a submitted application. - *

*

* The response, includes: *

    - *
  • A flag which indicates that the process of killing the application is - * completed or not.
    • + *
  • + * A flag which indicates that the process of killing the application is + * completed or not. + *
    • *
* Note: user is recommended to wait until this flag becomes true, otherwise if * the ResourceManager crashes before the process of killing the * application is completed, the ResourceManager may retry this * application on recovery. - *

* * @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; /** - *

The request sent by the ApplicationMaster to - * ResourceManager on registration.

- * - *

The registration includes details such as: - *

    - *
  • Hostname on which the AM is running.
    • - *
  • RPC Port
    • - *
  • Tracking URL
    • - *
- *

+ * The request sent by the {@code ApplicationMaster} to {@code ResourceManager} + * on registration. + *

+ * The registration includes details such as: + *

    + *
  • Hostname on which the AM is running.
    • + *
  • RPC Port
    • + *
  • Tracking URL
    • + *
* * @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest) */ @@ -83,20 +82,20 @@ public abstract class RegisterApplicationMasterRequest { public abstract void setHost(String host); /** - * Get the RPC port on which the ApplicationMaster - * is responding. - * @return the RPC port on which the ApplicationMaster is - * responding + * Get the RPC port on which the {@code ApplicationMaster} is + * responding. + * @return the RPC port on which the {@code ApplicationMaster} + * is responding */ @Public @Stable public abstract int getRpcPort(); /** - * Set the RPC port on which the ApplicationMaster is + * Set the RPC port on which the {@code ApplicationMaster} is * responding. - * @param port RPC port on which the ApplicationMaster is - * responding + * @param port RPC port 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; /** - *

The response sent by the ResourceManager to a new - * ApplicationMaster on registration.

- * - *

The response contains critical details such as: + * The response sent by the {@code ResourceManager} to a new + * {@code ApplicationMaster} on registration. + *

+ * The response contains critical details such as: *

    *
  • Maximum capability for allocated resources in the cluster.
    • - *
  • ApplicationACLs for the application.
    • + *
  • {@code ApplicationACL}s for the application.
    • *
  • ClientToAMToken master key.
    • *
- *

* * @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); /** - *

Get the container token to be used for authorization during starting - * container.

- *

Note: {@link NMToken} will be used for authenticating communication with - * NodeManager.

+ * Get the container token to be used for authorization during starting + * container. + *

+ * 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; /** - *

- * ApplicationAttemptReport is a report of an application attempt. - *

- * + * {@code ApplicationAttemptReport} is a report of an application attempt. *

* It includes details such as: *

    - *
  • {@link ApplicationAttemptId} of the application.
    • - *
  • Host on which the ApplicationMaster of this attempt is - * running.
    • - *
  • RPC port of the ApplicationMaster of this attempt.
    • - *
  • Tracking URL.
    • - *
  • Diagnostic information in case of errors.
    • - *
  • {@link YarnApplicationAttemptState} of the application attempt.
    • - *
  • {@link ContainerId} of the master Container.
    • + *
  • {@link ApplicationAttemptId} of the application.
    • + *
  • Host on which the ApplicationMaster of this attempt is + * running.
    • + *
  • RPC port of the ApplicationMaster of this attempt.
    • + *
  • Tracking URL.
    • + *
  • Diagnostic information in case of errors.
    • + *
  • {@link YarnApplicationAttemptState} of the application attempt.
    • + *
  • {@link ContainerId} of the master Container.
    • *
- *

- * */ @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; /** - *

ApplicationReport is a report of an application.

- * - *

It includes details such as: - *

    - *
  • {@link ApplicationId} of the application.
    • - *
  • Applications user.
    • - *
  • Application queue.
    • - *
  • Application name.
    • - *
  • Host on which the ApplicationMaster is running.
    • - *
  • RPC port of the ApplicationMaster.
    • - *
  • Tracking URL.
    • - *
  • {@link YarnApplicationState} of the application.
    • - *
  • Diagnostic information in case of errors.
    • - *
  • Start time of the application.
    • - *
  • Client {@link Token} of the application (if security is enabled).
    • - *
- *

+ * {@code ApplicationReport} is a report of an application. + *

+ * It includes details such as: + *

    + *
  • {@link ApplicationId} of the application.
    • + *
  • Applications user.
    • + *
  • Application queue.
    • + *
  • Application name.
    • + *
  • Host on which the ApplicationMaster is running.
    • + *
  • RPC port of the ApplicationMaster.
    • + *
  • Tracking URL.
    • + *
  • {@link YarnApplicationState} of the application.
    • + *
  • Diagnostic information in case of errors.
    • + *
  • Start time of the application.
    • + *
  • Client {@link Token} of the application (if security is enabled).
    • + *
* * @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. - *

+ *

* 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. - *

+ *

* The AMRM token will be returned only if all the following conditions are * met: - *

  • - *
      the requester is the owner of the ApplicationMaster
    - *
      the application master is an unmanaged ApplicationMaster
    - *
      the application master is in ACCEPTED state
    - *
    • + *
      + *
    • the requester is the owner of the ApplicationMaster
      • + *
    • the application master is an unmanaged ApplicationMaster
      • + *
    • the application master is in ACCEPTED state
      • + *
    * 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; /** - *

    ApplicationSubmissionContext represents all of the - * information needed by the ResourceManager to launch - * the ApplicationMaster for an application.

    - * - *

    It includes details such as: - *

      - *
    • {@link ApplicationId} of the application.
      • - *
    • Application user.
      • - *
    • Application name.
      • - *
    • {@link Priority} of the application.
      • - *
    • - * {@link ContainerLaunchContext} of the container in which the - * ApplicationMaster is executed. - *
      • - *
    • 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. + *

      + * It includes details such as: + *

        + *
      • {@link ApplicationId} of the application.
        • + *
      • Application user.
        • + *
      • Application name.
        • + *
      • {@link Priority} of the application.
        • + *
      • + * {@link ContainerLaunchContext} of the container in which the + * ApplicationMaster is executed. + *
        • + *
      • + * maxAppAttempts. The maximum number of application attempts. * It should be no larger than the global number of max attempts in the - * Yarn configuration.
        • - *
      • 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. - *
        • + * Yarn configuration. + * + *
      • + * 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. + *
        • *
      • Optional, application-specific {@link LogAggregationContext}
        • - *
      - *

      + *
    * * @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; /** - *

    Container represents an allocated resource in the cluster. - *

    - * - *

    The ResourceManager is the sole authority to allocate any - * Container to applications. The allocated Container + * {@code Container} represents an allocated resource in the cluster. + *

    + * 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.

    - * - *

    It includes details such as: - *

      - *
    • {@link ContainerId} for the container, which is globally unique.
      • - *
    • - * {@link NodeId} of the node on which it is allocated. - *
      • - *
    • HTTP uri of the node.
      • - *
    • {@link Resource} allocated to the container.
      • - *
    • {@link Priority} at which the container was allocated.
      • - *
    • - * Container {@link Token} of the container, used to securely verify - * authenticity of the allocation. - *
      • - *
    - *

    + * a specific amount of {@link Resource} allocated. + *

    + * It includes details such as: + *

      + *
    • {@link ContainerId} for the container, which is globally unique.
      • + *
    • + * {@link NodeId} of the node on which it is allocated. + *
      • + *
    • HTTP uri of the node.
      • + *
    • {@link Resource} allocated to the container.
      • + *
    • {@link Priority} at which the container was allocated.
      • + *
    • + * Container {@link Token} of the container, used to securely verify + * authenticity of the allocation. + *
      • + *
    * - *

    Typically, an ApplicationMaster receives the - * Container from the ResourceManager during - * resource-negotiation and then talks to the NodeManager to - * start/stop containers.

    + * 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; /** - *

    ContainerLaunchContext represents all of the information - * needed by the NodeManager to launch a container.

    - * - *

    It includes details such as: - *

      - *
    • {@link ContainerId} of the container.
      • - *
    • {@link Resource} allocated to the container.
      • - *
    • User to whom the container is allocated.
      • - *
    • Security tokens (if security is enabled).
      • - *
    • - * {@link LocalResource} necessary for running the container such - * as binaries, jar, shared-objects, side-files etc. - *
      • - *
    • Optional, application-specific binary service data.
      • - *
    • Environment variables for the launched process.
      • - *
    • Command to launch the container.
      • - *
    - *

    + * {@code ContainerLaunchContext} represents all of the information + * needed by the {@code NodeManager} to launch a container. + *

    + * It includes details such as: + *

      + *
    • {@link ContainerId} of the container.
      • + *
    • {@link Resource} allocated to the container.
      • + *
    • User to whom the container is allocated.
      • + *
    • Security tokens (if security is enabled).
      • + *
    • + * {@link LocalResource} necessary for running the container such + * as binaries, jar, shared-objects, side-files etc. + *
      • + *
    • Optional, application-specific binary service data.
      • + *
    • Environment variables for the launched process.
      • + *
    • Command to launch the container.
      • + *
    * * @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; /** - *

    - * ContainerReport is a report of an container. - *

    - * + * {@code ContainerReport} is a report of an container. *

    * It includes details such as: *

      - *
    • {@link ContainerId} of the container.
      • - *
    • Allocated Resources to the container.
      • - *
    • Assigned Node id.
      • - *
    • Assigned Priority.
      • - *
    • Creation Time.
      • - *
    • Finish Time.
      • - *
    • Container Exit Status.
      • - *
    • {@link ContainerState} of the container.
      • - *
    • Diagnostic information in case of errors.
      • - *
    • Log URL.
      • - *
    • nodeHttpAddress
      • + *
    • {@link ContainerId} of the container.
      • + *
    • Allocated Resources to the container.
      • + *
    • Assigned Node id.
      • + *
    • Assigned Priority.
      • + *
    • Creation Time.
      • + *
    • Finish Time.
      • + *
    • Container Exit Status.
      • + *
    • {@link ContainerState} of the container.
      • + *
    • Diagnostic information in case of errors.
      • + *
    • Log URL.
      • + *
    • nodeHttpAddress
      • *
    - *

    - * */ @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; /** - *

    ContainerStatus represents the current status of a - * Container.

    - * - *

    It provides details such as: - *

      - *
    • ContainerId of the container.
      • - *
    • ContainerState of the container.
      • - *
    • Exit status of a completed container.
      • - *
    • Diagnostic message for a failed container.
      • - *
    - *

    + * {@code ContainerStatus} represents the current status of a + * {@code Container}. + *

    + * It provides details such as: + *

      + *
    • {@code ContainerId} of the container.
      • + *
    • {@code ContainerState} of the container.
      • + *
    • Exit status of a completed container.
      • + *
    • Diagnostic message for a failed container.
      • + *
    */ @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; /** - *

    LocalResourceType specifies the type - * of a resource localized by the NodeManager.

    - * - *

    The type can be one of: - *

      - *
    • - * {@link #FILE} - Regular file i.e. uninterpreted bytes. - *
      • - *
    • - * {@link #ARCHIVE} - Archive, which is automatically unarchived by the - * NodeManager. - *
      • - *
    • - * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. - *
    - *

    + * {@code LocalResourceType} specifies the type + * of a resource localized by the {@code NodeManager}. + *

    + * The type can be one of: + *

      + *
    • + * {@link #FILE} - Regular file i.e. uninterpreted bytes. + *
      • + *
    • + * {@link #ARCHIVE} - Archive, which is automatically unarchived by the + * NodeManager. + *
      • + *
    • + * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. + *
      • + *
    * * @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; /** - *

    LocalResourceVisibility specifies the visibility - * of a resource localized by the NodeManager.

    - * - *

    The visibility can be one of: - *

      - *
    • {@link #PUBLIC} - Shared by all users on the node.
      • - *
    • - * {@link #PRIVATE} - Shared among all applications of the - * same user on the node. - *
      • - *
    • - * {@link #APPLICATION} - Shared only among containers of the - * same application on the node. - *
      • - *
    - *

    + * {@code LocalResourceVisibility} specifies the visibility + * of a resource localized by the {@code NodeManager}. + *

    + * The visibility can be one of: + *

      + *
    • {@link #PUBLIC} - Shared by all users on the node.
      • + *
    • + * {@link #PRIVATE} - Shared among all applications of the + * same user on the node. + *
      • + *
    • + * {@link #APPLICATION} - Shared only among containers of the + * same application on the node. + *
      • + *
    * * @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; /** - *

    LogAggregationContext represents all of the - * information needed by the NodeManager to handle - * the logs for an application.

    - * - *

    It includes details such as: - *

      - *
    • 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. + *

      + * It includes details such as: + *

        + *
      • + * 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.
        • - *
      • excludePattern. It uses Java Regex to filter the log files + * will be uploaded when the application finishes. + *
        • + *
      • + * 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
        • - *
      • rolledLogsIncludePattern. It uses Java Regex to filter the log files + * will be excluded eventually. + *
        • + *
      • + * 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.
        • - *
      • rolledLogsExcludePattern. It uses Java Regex to filter the log files + * will be aggregated in a rolling fashion. + *
        • + *
      • + * 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
        • - *
      - *

      + * will be excluded eventually. + *
      • + *
    * * @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; /** - *

    NodeReport is a summary of runtime information of a - * node in the cluster.

    - * - *

    It includes details such as: - *

      - *
    • {@link NodeId} of the node.
      • - *
    • HTTP Tracking URL of the node.
      • - *
    • Rack name for the node.
      • - *
    • Used {@link Resource} on the node.
      • - *
    • Total available {@link Resource} of the node.
      • - *
    • Number of running containers on the node.
      • - *
    - *

    + * {@code NodeReport} is a summary of runtime information of a node + * in the cluster. + *

    + * It includes details such as: + *

      + *
    • {@link NodeId} of the node.
      • + *
    • HTTP Tracking URL of the node.
      • + *
    • Rack name for the node.
      • + *
    • Used {@link Resource} on the node.
      • + *
    • Total available {@link Resource} of the node.
      • + *
    • Number of running containers on the node.
      • + *
    * * @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; /** - *

    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 - * ApplicationMaster (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.

    - * - *

    The AM should decode both parts of the message. The {@link + * cluster. + *

    + * 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.

    - * - *

    In contrast, the {@link PreemptionContract} also includes a description of + * caused the RM to ask for the container will change. + *

    + * 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.

    - * - *

    Each preemption message reflects the RM's current understanding of the - * cluster state, so a request to return N containers may not + * PreemptionContract#getContainers()} may not be killed. + *

    + * Each preemption message reflects the RM's current understanding of the + * cluster state, so a request to return N 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.

    - * - *

    The policy enforced by the RM is part of the scheduler. Generally, only + * subsequent requests. + *

    + * 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.

    + * 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; /** - *

    - * QueueACL enumerates the various ACLs for queues. - *

    - * + * {@code QueueACL} enumerates the various ACLs for queues. *

    * The ACL is one of: *

      - *
    • {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the - * queue.
      • - *
    • {@link #ADMINISTER_QUEUE} - ACL to administer the queue.
      • + *
    • + * {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue. + *
      • + *
    • {@link #ADMINISTER_QUEUE} - ACL to administer the queue.
      • *
    - *

    * * @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; /** - *

    QueueInfo is a report of the runtime information of the queue.

    - * - *

    It includes information such as: - *

      - *
    • Queue name.
      • - *
    • Capacity of the queue.
      • - *
    • Maximum capacity of the queue.
      • - *
    • Current capacity of the queue.
      • - *
    • Child queues.
      • - *
    • Running applications.
      • - *
    • {@link QueueState} of the queue.
      • - *
    - *

    + * QueueInfo is a report of the runtime information of the queue. + *

    + * It includes information such as: + *

      + *
    • Queue name.
      • + *
    • Capacity of the queue.
      • + *
    • Maximum capacity of the queue.
      • + *
    • Current capacity of the queue.
      • + *
    • Child queues.
      • + *
    • Running applications.
      • + *
    • {@link QueueState} of the queue.
      • + *
    * * @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; /** - *

    State of a Queue.

    - * - *

    A queue is in one of: - *

      - *
    • {@link #RUNNING} - normal state.
      • - *
    • {@link #STOPPED} - not accepting new application submissions. - *
    - *

    + * State of a Queue. + *

    + * A queue is in one of: + *

      + *
    • {@link #RUNNING} - normal state.
      • + *
    • {@link #STOPPED} - not accepting new application submissions.
      • + *
    * * @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; /** - *

    * {@link ReservationRequest} represents the request made by an application to * the {@code ResourceManager} to reserve {@link Resource}s. - *

    - * *

    * It includes: *

      - *
    • {@link Resource} required for each request.
      • - *
    • - * Number of containers, of above specifications, which are required by the - * application.
      • - *
    • - * Concurrency that indicates the gang size of the request.
      • + *
    • {@link Resource} required for each request.
      • + *
    • + * Number of containers, of above specifications, which are required by the + * application. + *
      • + *
    • Concurrency that indicates the gang size of the request.
      • *
    - *

    - * */ @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}. - * + *

    * 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. + *

    * 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). - * + *

    * 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; /** - *

    ResourceRequest represents the request made by an - * application to the ResourceManager to obtain various - * Container allocations.

    - * - *

    It includes: - *

      - *
    • {@link Priority} of the request.
      • - *
    • - * The name of the machine or rack on which the allocation is - * desired. A special value of * signifies that - * any host/rack is acceptable to the application. - *
      • - *
    • {@link Resource} required for each request.
      • - *
    • - * Number of containers, of above specifications, which are required - * by the application. - *
      • - *
    • - * A boolean relaxLocality flag, defaulting to true, - * which tells the ResourceManager if the application wants - * locality to be loose (i.e. allows fall-through to rack or any) - * or strict (i.e. specify hard constraint on resource allocation). - *
      • - *
    - *

    + * {@code ResourceRequest} represents the request made + * by an application to the {@code ResourceManager} + * to obtain various {@code Container} allocations. + *

    + * It includes: + *

      + *
    • {@link Priority} of the request.
      • + *
    • + * The name of the machine or rack on which the allocation is + * desired. A special value of * signifies that + * any host/rack is acceptable to the application. + *
      • + *
    • {@link Resource} required for each request.
      • + *
    • + * Number of containers, of above specifications, which are required + * by the application. + *
      • + *
    • + * A boolean relaxLocality 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 any) + * or strict (i.e. specify hard constraint on resource allocation). + *
      • + *
    * * @see Resource * @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest) @@ -267,7 +266,7 @@ public abstract class ResourceRequest implements Comparable { /** * 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 NodeId to ResourceOption. - * @return the map of + * @return the map of {@code } */ @Public @Evolving @@ -62,7 +62,7 @@ public abstract class UpdateNodeResourceRequest { /** * Set the map from NodeId to ResourceOption. - * @param nodeResourceMap the map of + * @param nodeResourceMap the map of {@code } */ @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 { } /** - *

    * Get a report of the given Application. - *

    - * *

    * In secure mode, YARN verifies access to the application, queue * etc. before accepting the request. - *

    - * *

    * If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

      - *
    • host - set to "N/A"
      • - *
    • RPC port - set to -1
      • - *
    • client token - set to "N/A"
      • - *
    • diagnostics - set to "N/A"
      • - *
    • tracking URL - set to "N/A"
      • - *
    • original tracking URL - set to "N/A"
      • - *
    • resource usage report - all values are -1
      • + *
    • host - set to "N/A"
      • + *
    • RPC port - set to -1
      • + *
    • client token - set to "N/A"
      • + *
    • diagnostics - set to "N/A"
      • + *
    • tracking URL - set to "N/A"
      • + *
    • original tracking URL - set to "N/A"
      • + *
    • resource usage report - all values are -1
      • *
    - *

    * * @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)