org.apache.hadoop.yarn.server.timelineservice.collector

Class TimelineCollectorWebService

java.lang.Object

org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorWebService

@InterfaceAudience.Private
 @InterfaceStability.Unstable
 @Path(value="/ws/v2/timeline")
public class TimelineCollectorWebService
extends Object

The main per-node REST end point for timeline service writes. It is essentially a container service that routes requests to the appropriate per-app services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimelineCollectorWebService.AboutInfo Gives information about timeline collector.

Constructor Summary

Constructors

Constructor and Description
TimelineCollectorWebService()

Method Summary

Modifier and Type	Method and Description
TimelineCollectorWebService.AboutInfo	about(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Return the description of the timeline web services.
javax.ws.rs.core.Response	putDomain(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String appId, org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain)
javax.ws.rs.core.Response	putEntities(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String async, String isSubAppEntities, String appId, org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities) Accepts writes to the collector, and returns a response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimelineCollectorWebService

public TimelineCollectorWebService()

Method Detail

about

@GET
 @Produces(value="application/json; charset=utf-8")
public TimelineCollectorWebService.AboutInfo about(@Context
                                                                                                            javax.servlet.http.HttpServletRequest req,
                                                                                                            @Context
                                                                                                            javax.servlet.http.HttpServletResponse res)

Return the description of the timeline web services.

Parameters:

req - Servlet request.

res - Servlet response.

Returns:

description of timeline web service.

putEntities

@PUT
 @Path(value="/entities")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response putEntities(@Context
                                                                                                                 javax.servlet.http.HttpServletRequest req,
                                                                                                                 @Context
                                                                                                                 javax.servlet.http.HttpServletResponse res,
                                                                                                                 @QueryParam(value="async")
                                                                                                                 String async,
                                                                                                                 @QueryParam(value="subappwrite")
                                                                                                                 String isSubAppEntities,
                                                                                                                 @QueryParam(value="appid")
                                                                                                                 String appId,
                                                                                                                 org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities)

Accepts writes to the collector, and returns a response. It simply routes the request to the app level collector. It expects an application as a context.

Parameters:

req - Servlet request.

res - Servlet response.

async - flag indicating whether its an async put or not. "true" indicates, its an async call. If null, its considered false.

appId - Application Id to which the entities to be put belong to. If appId is not there or it cannot be parsed, HTTP 400 will be sent back.

entities - timeline entities to be put.

Returns:

a Response with appropriate HTTP status.

putDomain

@PUT
 @Path(value="/domain")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response putDomain(@Context
                                                                                                             javax.servlet.http.HttpServletRequest req,
                                                                                                             @Context
                                                                                                             javax.servlet.http.HttpServletResponse res,
                                                                                                             @QueryParam(value="appid")
                                                                                                             String appId,
                                                                                                             org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain)

Parameters:

req - Servlet request.

res - Servlet response.

domain - timeline domain to be put.

appId - Application Id to which the domain to be put belong to. If appId is not there or it cannot be parsed, HTTP 400 will be sent back.

Returns:

a Response with appropriate HTTP status.