[MAPREDUCE-5339] There are methods and capabilities in Job and other Classes for which no information is provided in Javadoc.

• Type: Bug
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 2.1.0-beta, 2.0.5-alpha
• Component/s: documentation

Environment

Does not matter

• Assignee: Unassigned
• Reporter: Pranay Varma
• Created: 22/Jun/13 21:56
• Updated: 23/Jun/13 04:35

Description

http://hadoop.apache.org/docs/current/api/org/apache/hadoop/mapreduce/Job.html

The uber capability is not defined. isUber does not indicate what uber is.
Only the signature is provided. I would like to know what the uber capability is. there is no reference to any other place where uber might have been defined.

The same is true of isRetired. All methods of the Job class should be checked to make sure that the context is clear. isRetired does not indicate how a job gets Retired since there is no setRetired. There should be some reference to the process of retiring.

http://hadoop.apache.org/docs/current/api/org/apache/hadoop/mapreduce/Cluster.html
This class should have some information before it goes into fields and methods.

There is no information about what root queues are and what child queues are. It would seem that root queues are created first and these root queues have child queues. It is also not clear what one would do if they get child queues without knowing which root queue it is associated with. Is that important?
Does getAllQeues return root queues + child queues? This question is not well answered.

Cluster also keeps blacklisted Task Trackers. There is no info or reference in the javadoc regarding how or why a Task is black listed.

JobACL is referenced in the javadoc for JobStatus but there is no javadoc for JobACL or security.authorize.AccessControlList.

Issue Links

• is duplicated by: MAPREDUCE-5340 isRetired is not well defined. javadoc does not indicate how a job is retired and waht does retired mean.