diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java index 9442c5325e2..760e2515640 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java @@ -263,6 +263,7 @@ public interface ApplicationConstants { * Note: Use $$() method for cross-platform practice i.e. submit an * application from a Windows client to a Linux/Unix server or vice versa. *
+ * @return expanded environment variable. */ public String $() { if (Shell.WINDOWS) { @@ -278,6 +279,7 @@ public interface ApplicationConstants { * expansion marker ('%' for Windows and '$' for Linux) by NodeManager on * container launch. For example: {{VAR}} will be replaced as $VAR on Linux, * and %VAR% on Windows. + * @return expanded environment variable. */ @Public @Unstable 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 0b65e5ca3b6..e24ebdff7a1 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 @@ -199,6 +199,9 @@ public abstract class AllocateRequest { /** * Get the list of container resource increase requests being sent by the *ApplicationMaster
.
+ * @return the list of {@link ContainerResourceChangeRequest}
+ * being sent by the
+ * ApplicationMaster
.
*/
@Public
@Unstable
@@ -207,7 +210,9 @@ public abstract class AllocateRequest {
/**
* Set the list of container resource increase requests to inform the
* ResourceManager
about the containers whose resources need
- * to be increased.
+ * to be increased.
+ * @param increaseRequests list of
+ * {@link ContainerResourceChangeRequest}
*/
@Public
@Unstable
@@ -217,6 +222,9 @@ public abstract class AllocateRequest {
/**
* Get the list of container resource decrease requests being sent by the
* ApplicationMaster
.
+ * @return list of {@link ContainerResourceChangeRequest}
+ * being sent by the
+ * ApplicationMaster
.
*/
@Public
@Unstable
@@ -226,6 +234,8 @@ public abstract class AllocateRequest {
* Set the list of container resource decrease requests to inform the
* ResourceManager
about the containers whose resources need
* to be decreased.
+ * @param decreaseRequests list of
+ * {@link ContainerResourceChangeRequest}
*/
@Public
@Unstable
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 2567a51f87a..4fba4238593 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
@@ -279,6 +279,7 @@ public abstract class AllocateResponse {
* 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.
+ * @return list of NMTokens required for communicating with NM
*/
@Public
@Stable
@@ -291,6 +292,7 @@ public abstract class AllocateResponse {
/**
* Get the list of newly increased containers by
* ResourceManager
.
+ * @return list of newly increased containers
*/
@Public
@Unstable
@@ -308,6 +310,7 @@ public abstract class AllocateResponse {
/**
* Get the list of newly decreased containers by
* ResourceManager
.
+ * @return the list of newly decreased containers
*/
@Public
@Unstable
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 6647a10bb04..b2bac68e48f 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
@@ -59,6 +59,8 @@ public abstract class FinishApplicationMasterResponse {
/**
* Get the flag which indicates that the application has successfully
* unregistered with the RM and the application can safely stop.
+ * @return true if the application has unregistered with the RM,
+ * false otherwise
*/
@Public
@Stable
@@ -67,6 +69,8 @@ public abstract class FinishApplicationMasterResponse {
/**
* Set the flag which indicates that the application has successfully
* unregistered with the RM and the application can safely stop.
+ * @param isUnregistered boolean flag to indicate that the application has
+ * successfully unregistered with the RM
*/
@Private
@Unstable
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 35392e44d52..5cc9cc12d71 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
@@ -116,6 +116,7 @@ public abstract class GetApplicationsRequest {
*
* @param scope {@link ApplicationsRequestScope} to filter by
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
+ * @return a report of Applications in {@link GetApplicationsRequest}
*/
@Public
@Stable
@@ -136,6 +137,7 @@ public abstract class GetApplicationsRequest {
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
+ * @return a report of Applications in {@link GetApplicationsRequest}
*/
@Public
@Stable
@@ -156,6 +158,7 @@ public abstract class GetApplicationsRequest {
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
+ * @return a report of Applications in {@link GetApplicationsRequest}
*/
@Public
@Stable
@@ -176,6 +179,7 @@ public abstract class GetApplicationsRequest {
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
+ * @return a report of Applications in GetApplicationsRequest
*/
@Public
@Stable
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java
index bf642cc129e..32e3d3a24f8 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java
@@ -56,11 +56,13 @@ public abstract class GetClusterNodesRequest {
/**
* The state to filter the cluster nodes with.
+ * @return the set of {@link NodeState}
*/
public abstract EnumSetThe ClientToAMToken master key is sent to ApplicationMaster
* by ResourceManager
via {@link RegisterApplicationMasterResponse}
* , used to verify corresponding ClientToAMToken.
Get the queue that the application was placed in.
+ * @return the queue that the application was placed in. */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java index 0b5275c00f1..6ab33602879 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java @@ -52,6 +52,7 @@ public abstract class ReservationListRequest { * to be returned. Reservation allocations are subject to * change in the event of re-planning as described by * {@code ReservationDefinition}. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable @@ -84,6 +85,7 @@ public abstract class ReservationListRequest { * to be returned. Reservation allocations are subject to * change in the event of re-planning as described by * {@code ReservationDefinition}. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable @@ -105,6 +107,7 @@ public abstract class ReservationListRequest { * @param reservationId Optional. String representation of * {@code ReservationId} If provided, other fields will * be ignored. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java index 8dfda4594f5..8905ae2ae4d 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java @@ -78,6 +78,7 @@ public abstract class StartContainersResponse { /** * Get the containerId-to-exception map in which the exception indicates error * from per container for failed requests + * @return map of containerId-to-exception */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java index a0f54d1b7df..2763bc94b4c 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java @@ -74,6 +74,7 @@ public abstract class StopContainersResponse { /** * Get the containerId-to-exception map in which the exception indicates error * from per container for failed requests + * @return map of containerId-to-exception */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java index 726d9699c27..e243e9051fb 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java @@ -193,6 +193,9 @@ public abstract class LocalResource { /** * NM uses it to decide whether if it is necessary to upload the resource to * the shared cache + * @return true if it is necessary to upload the resource + * to the shared cache, + * false otherwise */ @Public @Unstable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java index 8c5d00b3f7b..594832e005d 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java @@ -263,7 +263,10 @@ public class HAUtil { return (value == null) ? defaultValue : value; } - /** Add non empty and non null suffix to a key */ + /** + * Add non empty and non null suffix to a key. + * @return the suffixed key + */ public static String addSuffix(String key, String suffix) { if (suffix == null || suffix.isEmpty()) { return key;