[jira] [Updated] (YARN-6159) Documentation changes for TimelineV2Client

["Varun Saxena (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/YARN-6159?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Varun Saxena updated YARN-6159:
-------------------------------
    Fix Version/s: 2.9.0

> Documentation changes for TimelineV2Client
> ------------------------------------------
>
>                 Key: YARN-6159
>                 URL: https://issues.apache.org/jira/browse/YARN-6159
>             Project: Hadoop YARN
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Varun Saxena
>            Assignee: Naganarasimha G R
>            Priority: Minor
>             Fix For: 2.9.0, YARN-5355, YARN-5355-branch-2, 3.0.0-alpha4
>
>         Attachments: TimelineServiceV2.html, YARN-6159.v1.001.patch, YARN-6159.v1.002.patch, YARN-6159.v1.003.patch, YARN-6159.v1.004.patch
>
>
> 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.
> {code}
>     // 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) {
> {code}
> Below can also be changed to client to keep it consistent.
> {code}
>     amRMClient.registerTimelineClient(timelineClient);
> {code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org