Siddharth Seth commented on YARN-805:

Would be good if others take a look at the patch as well, since it documents 
long term API support.
- Do the allocate APIs need to be marked as Evolving, should be looked at by 
someone who's been tracking YARN-397 closely.
- Is this jira also supposed to add comments to the .proto files ?, or will 
that be a separate jira 
- Protocols vs Client libraries as the public interface.
- Some methods are annotated private, unstable - others just private, is there 
a reason for this ?
- Are the QueueInfo APIs stable ?
- GetAllApplicationRequest is being changed in YARN-727 - so the annotations 
may need to change depending on what happens on when that gets committed.
- The methods related to renew / cancellation of delegation tokens should 
continue to stay Private. The RM controls this for now.
- Annotations missing on StartContainerRequestPBImpl
- AMCommand - should this be marked as Evolving since additional commands may 
be added in the future. Similarly for NodeState. This likely needs to make it 
to the rolling upgrades jira as well - handling enumerations returned by method 
- ApplicationAttemptId, ApplicationId - appAttemptIdStrPrefix, appIdPrefix 
should be marked Private
- ApplicationReport.getCurrentApplicationAttemptId - should this be stable ?
- ApplicationReport.getOriginalTrackingUrl - private ? meant for proxy use only.
- ApplicationResourceUsageReport.getNumReservedContainers - not sure what 
numReservedContainers means in the context of multiple resources. Should 
probably be removed or marked private. Similarly NodeReport.getNumContainers
- ApplicationSubmissionContext.setPriority - don't think this is used by any 
scheduler yet. Should it be private for now ?
- ApplcationnSubmissionContext.setCancelTokensWhenComplete - evolving ?
- ApplicationSubmissionContext.setResource needs javadoc
- ContainerStatus.getExitStatus seems a little ambiguous. Evolving ?
- NodeId, AppId, AppAttemptId don't need annotations on their protected setters
- ResourceRequest/ResourceBlacklistRequest - update javadoc to say resource 
name instead of resource.
- YarnRuntimeException - I believe this is meant for internal exceptions within 
YARN. private/LimitedPrivate("mapreduce") since this leaks all over MR code.
- Should RegisterApplicationMasterRequest have a hostname only newInstance(). 
All apps won't necessarily have an rpc port and tracking url.

> Fix yarn-api javadoc annotations
> --------------------------------
>                 Key: YARN-805
>                 URL: https://issues.apache.org/jira/browse/YARN-805
>             Project: Hadoop YARN
>          Issue Type: Sub-task
>            Reporter: Jian He
>            Assignee: Jian He
>            Priority: Blocker
>         Attachments: YARN-805.1.patch, YARN-805.patch

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to