big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

YARN-11380. Fix hadoop-yarn-api module Java Doc Errors. (#5152). Contributed by Shilun Fan.

Browse Source 
Signed-off-by: Ayush Saxena <ayushsaxena@apache.org>
This commit is contained in:
slfan1989 2022-11-28 21:24:32 +08:00 committed by GitHub
parent 1a7acc403b
commit f93167e678
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
42 changed files with 213 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java
View File

@ -94,8 +94,8 @@ public interface ApplicationBaseProtocol {
* @param request
* request for an application report
* @return application report
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -126,8 +126,8 @@ public GetApplicationReportResponse getApplicationReport(
* request for report on applications
* @return report on applications matching the given application types defined
* in the request
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see GetApplicationsRequest
*/
@Public
@ -166,8 +166,8 @@ public GetApplicationReportResponse getApplicationReport(
* @param request
* request for an application attempt report
* @return application attempt report
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -199,8 +199,8 @@ public GetApplicationAttemptReportResponse getApplicationAttemptReport(
* @param request
* request for reports on all application attempts of an application
* @return reports on all application attempts of an application
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -234,8 +234,8 @@ public GetApplicationAttemptsResponse getApplicationAttempts(
* @param request
* request for a container report
* @return container report
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -271,8 +271,8 @@ public GetContainerReportResponse getContainerReport(
* @param request
* request for a list of container reports of an application attempt.
* @return reports on all containers of an application attempt
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -293,8 +293,8 @@ public GetContainersResponse getContainers(GetContainersRequest request)
* @param request
* request to get a delegation token for the client.
* @return delegation token that can be used to talk to this service
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -308,8 +308,8 @@ public GetDelegationTokenResponse getDelegationToken(
* @param request
* the delegation token to be renewed.
* @return the new expiry time for the delegation token.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Private
@Unstable
@ -323,8 +323,8 @@ public RenewDelegationTokenResponse renewDelegationToken(
* @param request
* the delegation token to be cancelled.
* @return an empty response.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Private
@Unstable

72
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java
View File

@ -112,8 +112,8 @@ public interface ApplicationClientProtocol extends ApplicationBaseProtocol {
* @param request request to get a new <code>ApplicationId</code>
* @return response containing the new <code>ApplicationId</code> to be used
* to submit an application
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see #submitApplication(SubmitApplicationRequest)
*/
@Public
@ -157,8 +157,8 @@ public GetNewApplicationResponse getNewApplication(
*
* @param request request to submit a new application
* @return (empty) response on accepting the submission
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see #getNewApplication(GetNewApplicationRequest)
*/
@Public
@ -184,8 +184,8 @@ public SubmitApplicationResponse submitApplication(
* @param request request to fail an attempt
* @return <code>ResourceManager</code> returns an empty response
* on success and throws an exception on rejecting the request
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)
*/
@Public
@ -210,8 +210,8 @@ public FailApplicationAttemptResponse failApplicationAttempt(
* @param request request to abort a submitted application
* @return <code>ResourceManager</code> returns an empty response
* on success and throws an exception on rejecting the request
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)
*/
@Public
@ -232,8 +232,8 @@ public KillApplicationResponse forceKillApplication(
*
* @param request request for cluster metrics
* @return cluster metrics
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -252,8 +252,8 @@ public GetClusterMetricsResponse getClusterMetrics(
*
* @param request request for report on all nodes
* @return report on all nodes
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -274,8 +274,8 @@ public GetClusterNodesResponse getClusterNodes(
*
* @param request request to get queue information
* @return queue information
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -294,8 +294,8 @@ public GetQueueInfoResponse getQueueInfo(
*
* @param request request to get queue acls for <em>current user</em>
* @return queue acls for <em>current user</em>
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -309,8 +309,8 @@ public GetQueueUserAclsInfoResponse getQueueUserAcls(
*
* @param request the application ID and the target queue
* @return an empty response
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -383,7 +383,7 @@ GetNewReservationResponse getNewReservation(
* @return response the {@link ReservationId} on accepting the submission
* @throws YarnException if the request is invalid or reservation cannot be
* created successfully
* @throws IOException
* @throws IOException io error occur.
*
*/
@Public
@ -417,7 +417,7 @@ public ReservationSubmissionResponse submitReservation(
* @return response empty on successfully updating the existing reservation
* @throws YarnException if the request is invalid or reservation cannot be
* updated successfully
* @throws IOException
* @throws IOException io error occur.
*
*/
@Public
@ -439,7 +439,7 @@ public ReservationUpdateResponse updateReservation(
* @return response empty on successfully deleting the existing reservation
* @throws YarnException if the request is invalid or reservation cannot be
* deleted successfully
* @throws IOException
* @throws IOException io error occur.
*
*/
@Public
@ -494,13 +494,13 @@ ReservationListResponse listReservations(
/**
* <p>
* The interface used by client to get node to labels mappings in existing cluster
* The interface used by client to get node to labels mappings in existing cluster.
* </p>
*
* @param request
* @param request get node to labels request.
* @return node to labels mappings
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -510,13 +510,13 @@ public GetNodesToLabelsResponse getNodeToLabels(
/**
* <p>
* The interface used by client to get labels to nodes mappings
* in existing cluster
* in existing cluster.
* </p>
*
* @param request
* @param request get label to nodes request.
* @return labels to nodes mappings
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -530,8 +530,8 @@ public GetLabelsToNodesResponse getLabelsToNodes(
*
* @param request to get node labels collection of this cluster
* @return node labels collection of this cluster
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -544,8 +544,8 @@ public GetClusterNodeLabelsResponse getClusterNodeLabels(
* </p>
* @param request to set priority of an application
* @return an empty response
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -573,8 +573,8 @@ public UpdateApplicationPriorityResponse updateApplicationPriority(
* @param request request to signal a container
* @return <code>ResourceManager</code> returns an empty response
* on success and throws an exception on rejecting the request
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable
@ -691,7 +691,7 @@ GetClusterNodeAttributesResponse getClusterNodeAttributes(
* @param request request to get nodes to attributes mapping.
* @return nodes to attributes mappings.
* @throws YarnException if any error happens inside YARN.
* @throws IOException
* @throws IOException io error occur.
*/
@Public
@Unstable

14
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationMasterProtocol.java
View File

@ -76,9 +76,9 @@ public interface ApplicationMasterProtocol {
* </p>
*
* @param request registration request
* @return registration respose
* @throws YarnException
* @throws IOException
* @return registration response
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @throws InvalidApplicationMasterRequestException The exception is thrown
* when an ApplicationMaster tries to register more then once.
* @see RegisterApplicationMasterRequest
@ -104,8 +104,8 @@ public RegisterApplicationMasterResponse registerApplicationMaster(
*
* @param request completion request
* @return completion response
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @see FinishApplicationMasterRequest
* @see FinishApplicationMasterResponse
*/
@ -154,8 +154,8 @@ public FinishApplicationMasterResponse finishApplicationMaster(
* @param request
* allocation request
* @return allocation response
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
* @throws InvalidApplicationMasterRequestException
* This exception is thrown when an ApplicationMaster calls allocate
* without registering first.

8
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ClientSCMProtocol.java
View File

@ -55,8 +55,8 @@ public interface ClientSCMProtocol {
*
* @param request request to claim a resource in the shared cache
* @return response indicating if the resource is already in the cache
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
public UseSharedCacheResourceResponse use(
UseSharedCacheResourceRequest request) throws YarnException, IOException;
@ -81,8 +81,8 @@ public UseSharedCacheResourceResponse use(
*
* @param request request to release a resource in the shared cache
* @return (empty) response on releasing the resource
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
public ReleaseSharedCacheResourceResponse release(
ReleaseSharedCacheResourceRequest request) throws YarnException, IOException;

16
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ContainerManagementProtocol.java
View File

@ -102,8 +102,8 @@ public interface ContainerManagementProtocol {
* @return response including conatinerIds of all successfully launched
* containers, a containerId-to-exception map for failed requests and
* a allServicesMetaData map.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -138,8 +138,8 @@ StartContainersResponse startContainers(StartContainersRequest request)
* @return response which includes a list of containerIds of successfully
* stopped containers, a containerId-to-exception map for failed
* requests.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -174,8 +174,8 @@ StopContainersResponse stopContainers(StopContainersRequest request)
* successfully queried containers and a containerId-to-exception map
* for failed requests.
*
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Stable
@ -195,8 +195,8 @@ GetContainerStatusesResponse getContainerStatuses(
* whose resource has been successfully increased and a
* containerId-to-exception map for failed requests.
*
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/CsiAdaptorPlugin.java
View File

@ -36,7 +36,7 @@ public interface CsiAdaptorPlugin extends CsiAdaptorProtocol {
* customized configuration from yarn-site.xml.
* @param driverName the name of the csi-driver.
* @param conf configuration.
* @throws YarnException
* @throws YarnException exceptions from yarn servers.
*/
void init(String driverName, Configuration conf) throws YarnException;

16
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/CsiAdaptorProtocol.java
View File

@ -39,8 +39,8 @@ public interface CsiAdaptorProtocol {
* the name of the driver and its version.
* @param request get plugin info request.
* @return response that contains driver name and its version.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
GetPluginInfoResponse getPluginInfo(GetPluginInfoRequest request)
throws YarnException, IOException;
@ -51,8 +51,8 @@ GetPluginInfoResponse getPluginInfo(GetPluginInfoRequest request)
* or not, with a detailed message.
* @param request validate volume capability request.
* @return validation response.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
ValidateVolumeCapabilitiesResponse validateVolumeCapacity(
ValidateVolumeCapabilitiesRequest request) throws YarnException,
@ -63,8 +63,8 @@ ValidateVolumeCapabilitiesResponse validateVolumeCapacity(
* to the local file system and become visible for clients.
* @param request publish volume request.
* @return publish volume response.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
NodePublishVolumeResponse nodePublishVolume(
NodePublishVolumeRequest request) throws YarnException, IOException;
@ -75,8 +75,8 @@ NodePublishVolumeResponse nodePublishVolume(
* volume from given node.
* @param request un-publish volume request.
* @return un-publish volume response.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
NodeUnpublishVolumeResponse nodeUnpublishVolume(
NodeUnpublishVolumeRequest request) throws YarnException, IOException;

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Public
@Public
package org.apache.hadoop.yarn.api;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Public;

32
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java
View File

@ -137,6 +137,7 @@ public static GetApplicationsRequest newInstance(
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
* @param applicationTypes application types.
* @return a report of Applications in {@link GetApplicationsRequest}
*/
@Public
@ -158,6 +159,7 @@ public static GetApplicationsRequest newInstance(
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
* @param applicationStates application states.
* @return a report of Applications in {@link GetApplicationsRequest}
*/
@Public
@ -173,12 +175,14 @@ public static GetApplicationsRequest newInstance(
/**
* <p>
* The request from clients to get a report of Applications matching the
* giving and application types and application types in the cluster from the
* giving and application types and application states in the cluster from the
* <code>ResourceManager</code>.
* </p>
*
*
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
* @param applicationStates application states.
* @param applicationTypes application types.
* @return a report of Applications in <code>GetApplicationsRequest</code>
*/
@Public
@ -309,20 +313,20 @@ public static GetApplicationsRequest newInstance(
public abstract Range<Long> getStartRange();
/**
* Set the range of start times to filter applications on
* Set the range of start times to filter applications.
*
* @param range
* @param range range of start times.
*/
@Private
@Unstable
public abstract void setStartRange(Range<Long> range);
/**
* Set the range of start times to filter applications on
* Set the range of start times to filter applications.
*
* @param begin beginning of the range
* @param end end of the range
* @throws IllegalArgumentException
* @throws IllegalArgumentException if an argument is invalid.
*/
@Private
@Unstable
@ -330,7 +334,7 @@ public abstract void setStartRange(long begin, long end)
throws IllegalArgumentException;
/**
* Get the range of finish times to filter applications on
* Get the range of finish times to filter applications.
*
* @return {@link Range} of finish times to filter applications on
*/
@ -339,38 +343,38 @@ public abstract void setStartRange(long begin, long end)
public abstract Range<Long> getFinishRange();
/**
* Set the range of finish times to filter applications on
* Set the range of finish times to filter applications.
*
* @param range
* @param range range of finish times.
*/
@Private
@Unstable
public abstract void setFinishRange(Range<Long> range);
/**
* Set the range of finish times to filter applications on
* Set the range of finish times to filter applications.
*
* @param begin beginning of the range
* @param end end of the range
* @throws IllegalArgumentException
* @throws IllegalArgumentException if an argument is invalid.
*/
@Private
@Unstable
public abstract void setFinishRange(long begin, long end);
/**
* Get the tags to filter applications on
* Get the tags to filter applications.
*
* @return list of tags to filter on
* @return list of tags to filter.
*/
@Private
@Unstable
public abstract Set<String> getApplicationTags();
/**
* Set the list of tags to filter applications on
* Set the list of tags to filter applications.
*
* @param tags list of tags to filter on
* @param tags list of tags to filter.
*/
@Private
@Unstable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeAttributesResponse.java
View File

@ -42,7 +42,7 @@ public abstract class GetClusterNodeAttributesResponse {
/**
* Create instance of GetClusterNodeAttributesResponse.
*
* @param attributes
* @param attributes Map of Node attributeKey to Type.
* @return GetClusterNodeAttributesResponse.
*/
public static GetClusterNodeAttributesResponse newInstance(

7
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java
View File

@ -65,6 +65,7 @@ public static GetContainerStatusesResponse newInstance(
/**
* Set the <code>ContainerStatus</code>es of the requested containers.
* @param statuses <code>ContainerStatus</code>es of the requested containers.
*/
@Private
@Unstable
@ -72,7 +73,7 @@ public static GetContainerStatusesResponse newInstance(
/**
* Get the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* from per container for failed requests.
* @return map of containerId-to-exception
*/
@Public
@ -81,7 +82,9 @@ public static GetContainerStatusesResponse newInstance(
/**
* Set the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* from per container for failed requests.
*
* @param failedContainers containerId-to-exception map.
*/
@Private
@Unstable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetLocalizationStatusesResponse.java
View File

@ -80,6 +80,8 @@ public abstract void setLocalizationStatuses(
/**
* Set the containerId-to-exception map in which the exception indicates error
* from per container for failed request.
*
* @param failedContainers containerId-to-exception map.
*/
@InterfaceAudience.Private
public abstract void setFailedRequests(

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesRequest.java
View File

@ -48,7 +48,7 @@ public static GetNodesToAttributesRequest newInstance(Set<String> hostNames) {
/**
* Set hostnames for which mapping is required.
*
* @param hostnames
* @param hostnames Set of hostnames.
*/
@InterfaceAudience.Public
@InterfaceStability.Evolving

5
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java
View File

@ -68,6 +68,9 @@ public static IncreaseContainersResourceResponse newInstance(
/**
* Set the list of containerIds of containers whose resource have
* been successfully increased.
*
* @param succeedIncreasedContainers list of containerIds of containers whose resource have
* been successfully increased.
*/
@Private
@Unstable
@ -86,6 +89,8 @@ public abstract void setSuccessfullyIncreasedContainers(
/**
* Set the containerId-to-exception map in which the exception indicates
* error from each container for failed requests.
*
* @param failedRequests map of containerId-to-exception.
*/
@Private
@Unstable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java
View File

@ -66,6 +66,8 @@ public static KillApplicationResponse newInstance(boolean isKillCompleted) {
/**
* Set the flag which indicates that the process of killing application is completed or not.
* @param isKillCompleted true if the process of killing application has completed,
* false otherwise.
*/
@Private
@Unstable

3
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java
View File

@ -53,6 +53,9 @@ public abstract class RegisterApplicationMasterRequest {
* <li>trackingUrl: null</li>
* </ul>
* The port is allowed to be any integer larger than or equal to -1.
* @param host host on which the ApplicationMaster is running.
* @param port the RPC port on which the ApplicationMaster is responding.
* @param trackingUrl tracking URL for the ApplicationMaster.
* @return the new instance of <code>RegisterApplicationMasterRequest</code>
*/
@Public

7
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java
View File

@ -94,7 +94,7 @@ public static RegisterApplicationMasterResponse newInstance(
/**
* Set the <code>ApplicationACL</code>s for the application.
* @param acls
* @param acls ApplicationACLs for the application.
*/
@Private
@Unstable
@ -113,6 +113,8 @@ public static RegisterApplicationMasterResponse newInstance(
/**
* Set ClientToAMToken master key.
*
* @param key ClientToAMToken master key.
*/
@Public
@Stable
@ -127,7 +129,8 @@ public static RegisterApplicationMasterResponse newInstance(
public abstract String getQueue();
/**
* <p>Set the queue that the application was placed in.<p>
* <p>Set the queue that the application was placed in.</p>
* @param queue queue.
*/
@Public
@Stable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/SignalContainerRequest.java
View File

@ -56,6 +56,7 @@ public static SignalContainerRequest newInstance(ContainerId containerId,
/**
* Set the <code>ContainerId</code> of the container to signal.
* @param containerId containerId.
*/
@Public
@Unstable
@ -71,6 +72,7 @@ public static SignalContainerRequest newInstance(ContainerId containerId,
/**
* Set the <code>SignalContainerCommand</code> of the signal request.
* @param command signal container command.
*/
@Public
@Unstable

3
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java
View File

@ -86,7 +86,8 @@ public abstract void setSuccessfullyStartedContainers(
/**
* Set the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* from per container for failed requests.
* @param failedContainers container for failed requests.
*/
@Private
@Unstable

8
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java
View File

@ -65,6 +65,7 @@ public static StopContainersResponse newInstance(
/**
* Set the list of containerIds of successfully stopped containers.
* @param succeededRequests the list of containerIds of successfully stopped containers.
*/
@Private
@Unstable
@ -73,8 +74,8 @@ public abstract void setSuccessfullyStoppedContainers(
/**
* Get the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* @return map of containerId-to-exception
* from per container for failed requests.
* @return map of containerId-to-exception.
*/
@Public
@Stable
@ -82,7 +83,8 @@ public abstract void setSuccessfullyStoppedContainers(
/**
* Set the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* from per container for failed requests.
* @param failedRequests map of containerId-to-exception.
*/
@Private
@Unstable

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Public
@Public
package org.apache.hadoop.yarn.api.protocolrecords;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Public;

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java
View File

@ -516,7 +516,7 @@ public abstract void setAMContainerResourceRequests(
List<ResourceRequest> requests);
/**
* Get the attemptFailuresValidityInterval in milliseconds for the application
* Get the attemptFailuresValidityInterval in milliseconds for the application.
*
* @return the attemptFailuresValidityInterval
*/
@ -525,8 +525,8 @@ public abstract void setAMContainerResourceRequests(
public abstract long getAttemptFailuresValidityInterval();
/**
* Set the attemptFailuresValidityInterval in milliseconds for the application
* @param attemptFailuresValidityInterval
* Set the attemptFailuresValidityInterval in milliseconds for the application.
* @param attemptFailuresValidityInterval attempt failures validity interval.
*/
@Public
@Stable

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalizationStatus.java
View File

@ -59,7 +59,7 @@ public static LocalizationStatus newInstance(String resourceKey,
/**
* Sets the resource key.
* @param resourceKey
* @param resourceKey resource key.
*/
@InterfaceAudience.Private
public abstract void setResourceKey(String resourceKey);

14
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java
View File

@ -157,7 +157,7 @@ public static LogAggregationContext newInstance(String includePattern,
* Set include pattern. This includePattern only takes affect
* on logs that exist at the time of application finish.
*
* @param includePattern
* @param includePattern include pattern.
*/
@Public
@Unstable
@ -177,7 +177,7 @@ public static LogAggregationContext newInstance(String includePattern,
* Set exclude pattern. This excludePattern only takes affect
* on logs that exist at the time of application finish.
*
* @param excludePattern
* @param excludePattern exclude pattern.
*/
@Public
@Unstable
@ -195,7 +195,9 @@ public static LogAggregationContext newInstance(String includePattern,
/**
* Set include pattern in a rolling fashion.
*
* @param rolledLogsIncludePattern
* @param 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.
*/
@Public
@Unstable
@ -214,7 +216,7 @@ public abstract void setRolledLogsIncludePattern(
/**
* Set exclude pattern for in a rolling fashion.
*
* @param rolledLogsExcludePattern
* @param rolledLogsExcludePattern rolled logs exclude pattern.
*/
@Public
@Unstable
@ -233,7 +235,7 @@ public abstract void setRolledLogsExcludePattern(
/**
* Set the log aggregation policy class.
*
* @param className
* @param className log aggregation policy class name.
*/
@Public
@Unstable
@ -255,7 +257,7 @@ public abstract void setLogAggregationPolicyClassName(
* It is up to the log aggregation policy class to decide how to parse
* the parameters string.
*
* @param parameters
* @param parameters log aggregation policy parameters.
*/
@Public
@Unstable

4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java
View File

@ -243,6 +243,7 @@ public Integer getDecommissioningTimeout() {
/**
* Set the decommissioning timeout in seconds (null indicates absent timeout).
* @param decommissioningTimeout decommissioning time out.
* */
public void setDecommissioningTimeout(Integer decommissioningTimeout) {}
@ -256,7 +257,8 @@ public NodeUpdateType getNodeUpdateType() {
/**
* Set the node update type (null indicates absent node update type).
* */
* @param nodeUpdateType node update type.
*/
public void setNodeUpdateType(NodeUpdateType nodeUpdateType) {}
/**

1
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java
View File

@ -251,6 +251,7 @@ public static QueueInfo newInstance(String queueName,
/**
* Set the <code>accessible node labels</code> of the queue.
* @param labels node label expression of the queue.
*/
@Private
@Unstable

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java
View File

@ -437,17 +437,17 @@ public ExecutionTypeRequest getExecutionTypeRequest() {
/**
* <p>For a request at a network hierarchy level, set whether locality can be relaxed
* to that level and beyond.<p>
* to that level and beyond.</p>
*
* <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
* containers at that request's priority will not be assigned to nodes on that
* request's rack unless requests specifically for those nodes have also been
* submitted.<p>
* submitted.</p>
*
* <p>If the flag is off on an {@link ResourceRequest#ANY}-level
* <code>ResourceRequest</code>, containers at that request's priority will
* only be assigned on racks for which specific requests have also been
* submitted.<p>
* submitted.</p>
*
* <p>For example, to request a container strictly on a specific node, the
* corresponding rack-level and any-level requests should have locality

4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/SerializedException.java
View File

@ -38,6 +38,8 @@ public static SerializedException newInstance(Throwable e) {
/**
* Constructs a new <code>SerializedException</code> with the specified detail
* message and cause.
* @param message exception detail message.
* @param cause cause of the exception.
*/
@Private
@Unstable
@ -46,6 +48,7 @@ public static SerializedException newInstance(Throwable e) {
/**
* Constructs a new <code>SerializedException</code> with the specified detail
* message.
* @param message exception detail message.
*/
@Private
@Unstable
@ -53,6 +56,7 @@ public static SerializedException newInstance(Throwable e) {
/**
* Constructs a new <code>SerializedException</code> with the specified cause.
* @param cause cause of the exception.
*/
@Private
@Unstable

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Public
@Public
package org.apache.hadoop.yarn.api.records;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Public;

13
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/ConfigurationProvider.java
View File

@ -44,12 +44,12 @@ public void close() throws Exception {
}
/**
* Opens an InputStream at the indicated file
* @param bootstrapConf Configuration
* @param name The configuration file name
* Opens an InputStream at the indicated file.
* @param bootstrapConf Configuration.
* @param name The configuration file name.
* @return configuration
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
public abstract InputStream getConfigurationInputStream(
Configuration bootstrapConf, String name) throws YarnException,
@ -57,12 +57,15 @@ public abstract InputStream getConfigurationInputStream(
/**
* Derived classes initialize themselves using this method.
* @param bootstrapConf bootstrap configuration.
* @throws Exception exception occur.
*/
public abstract void initInternal(Configuration bootstrapConf)
throws Exception;
/**
* Derived classes close themselves using this method.
* @throws Exception exception occur.
*/
public abstract void closeInternal() throws Exception;
}

4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/ConfigurationProviderFactory.java
View File

@ -33,8 +33,8 @@ public class ConfigurationProviderFactory {
/**
* Creates an instance of {@link ConfigurationProvider} using given
* configuration.
* @param bootstrapConf
* @return configurationProvider
* @param bootstrapConf bootstrap configuration.
* @return configurationProvider configuration provider.
*/
@SuppressWarnings("unchecked")
public static ConfigurationProvider

7
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java
View File

@ -102,7 +102,7 @@ public static boolean isAutomaticFailoverEmbedded(Configuration conf) {
/**
* Verify configuration for Resource Manager HA.
* @param conf Configuration
* @throws YarnRuntimeException
* @throws YarnRuntimeException thrown by a remote service.
*/
public static void verifyAndSetConfiguration(Configuration conf)
throws YarnRuntimeException {
@ -320,7 +320,10 @@ public static String getConfValueForRMInstance(
}
/**
* Add non empty and non null suffix to a key.
* Add non-empty and non-null suffix to a key.
*
* @param key key.
* @param suffix suffix.
* @return the suffixed key
*/
public static String addSuffix(String key, String suffix) {

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Public
@Public
package org.apache.hadoop.yarn.conf;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Public;

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/exceptions/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,6 +15,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Public
@Public
package org.apache.hadoop.yarn.exceptions;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Public;

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/factories/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,6 +15,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Private
@Private
package org.apache.hadoop.yarn.factories;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Private;

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/factory/providers/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Private
@Private
package org.apache.hadoop.yarn.factory.providers;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Private;

4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/ResourceManagerAdministrationProtocol.java
View File

@ -106,8 +106,8 @@ public RefreshServiceAclsResponse refreshServiceAcls(
*
* @param request request to update resource for a node in cluster.
* @return (empty) response on accepting update.
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Private
@Idempotent

4
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/SCMAdminProtocol.java
View File

@ -42,8 +42,8 @@ public interface SCMAdminProtocol {
* @param request request <code>SharedCacheManager</code> to run a cleaner task
* @return <code>SharedCacheManager</code> returns an empty response
* on success and throws an exception on rejecting the request
* @throws YarnException
* @throws IOException
* @throws YarnException exceptions from yarn servers.
* @throws IOException io error occur.
*/
@Public
@Unstable

8
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RefreshNodesRequest.java
View File

@ -54,16 +54,16 @@ public static RefreshNodesRequest newInstance(
}
/**
* Set the DecommissionType
* Set the DecommissionType.
*
* @param decommissionType
* @param decommissionType decommission type.
*/
public abstract void setDecommissionType(DecommissionType decommissionType);
/**
* Get the DecommissionType
* Get the DecommissionType.
*
* @return decommissionType
* @return decommissionType decommission type.
*/
public abstract DecommissionType getDecommissionType();

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/package-info.java
View File

@ -1,4 +1,4 @@
/*
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@InterfaceAudience.Private
@Private
package org.apache.hadoop.yarn.server.api.protocolrecords;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceAudience.Private;

11
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/util/constraint/PlacementConstraintParser.java
View File

@ -165,7 +165,8 @@ public interface ConstraintTokenizer extends Enumeration<String> {
/**
* Validate the schema before actual parsing the expression.
* @throws PlacementConstraintParseException
* @throws PlacementConstraintParseException when the placement constraint parser
* fails to parse an expression.
*/
default void validate() throws PlacementConstraintParseException {
// do nothing
@ -633,9 +634,10 @@ public int getNumOfAllocations() {
/**
* Parses source tags from expression "sourceTags(numOfAllocations)".
* @param expr
* @param expr expression string.
* @return source tags, see {@link SourceTags}
* @throws PlacementConstraintParseException
* @throws PlacementConstraintParseException when the placement constraint parser
* fails to parse an expression.
*/
public static SourceTags parseFrom(String expr)
throws PlacementConstraintParseException {
@ -718,7 +720,8 @@ public static AbstractConstraint parseExpression(String constraintStr)
* </ul>
* @param expression expression string.
* @return a map of source tags to placement constraint mapping.
* @throws PlacementConstraintParseException
* @throws PlacementConstraintParseException when the placement constraint parser
* fails to parse an expression.
*/
public static Map<SourceTags, PlacementConstraint> parsePlacementSpec(
String expression) throws PlacementConstraintParseException {

6
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/util/csi/CsiConfigUtils.java
View File

@ -53,10 +53,10 @@ public static String getCsiDriverEndpoint(String driverName,
* Resolve the CSI adaptor address for a CSI driver from configuration.
* Expected configuration property name is
* yarn.nodemanager.csi-driver-adaptor.${driverName}.address.
* @param driverName
* @param conf
* @param driverName driver name.
* @param conf configuration.
* @return adaptor service address
* @throws YarnException
* @throws YarnException exceptions from yarn servers.
*/
public static InetSocketAddress getCsiAdaptorAddressForDriver(
String driverName, Configuration conf) throws YarnException {