[YARN-6159] Documentation changes for TimelineV2Client

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.9.0, YARN-5355, YARN-5355-branch-2, 3.0.0-alpha4
• Component/s: documentation
• Hadoop Flags: Reviewed
• Assignee: Naganarasimha G R
• Reporter: Varun Saxena
• Created: 08/Feb/17 12:37
• Updated: 21/Oct/17 06:06
• Resolved: 21/Feb/17 06:32

Description

Make documentation changes for TimelineV2Client i.e. to reflect changes made in client API in YARN-4675.

Also in TimelineServiceV2.md, under section Publishing application specific data, we have the following code snippet. Here, timelineClient.putEntitiesAsync(entity); should be client.putEntitiesAsync(entity); instead.

    // Create and start the Timeline client v.2
    TimelineClient client = TimelineClient.createTimelineClient(appId);
    client.init(conf);
    client.start();

    try {
      TimelineEntity myEntity = new TimelineEntity();
      myEntity.setEntityType("MY_APPLICATION");
      myEntity.setEntityId("MyApp1")
      // Compose other entity info

      // Blocking write
      client.putEntities(entity);

      TimelineEntity myEntity2 = new TimelineEntity();
      // Compose other info

      // Non-blocking write
      timelineClient.putEntitiesAsync(entity);

    } catch (IOException e) {
      // Handle the exception
    } catch (RuntimeException e) {

Below can also be changed to client to keep it consistent.

    amRMClient.registerTimelineClient(timelineClient);

Issue Links

• relates to: YARN-4675 Reorganize TimelineClient and TimelineClientImpl into separate classes for ATSv1.x and ATSv2