org.apache.hadoop.yarn.server.timeline.webapp

Class TimelineWebServices

java.lang.Object

org.apache.hadoop.yarn.server.timeline.webapp.TimelineWebServices

@Path(value="/ws/v1/timeline")
public class TimelineWebServices
extends Object

Constructor Summary

Constructors

Constructor and Description
TimelineWebServices(TimelineDataManager timelineDataManager)

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.yarn.api.records.timeline.TimelineAbout	about(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Return the description of the timeline web services.
org.apache.hadoop.yarn.api.records.timeline.TimelineDomain	getDomain(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String domainId) Return a single domain of the given domain Id.
org.apache.hadoop.yarn.api.records.timeline.TimelineDomains	getDomains(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String owner) Return a list of domains of the given owner.
org.apache.hadoop.yarn.api.records.timeline.TimelineEntities	getEntities(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String entityType, String primaryFilter, String secondaryFilter, String windowStart, String windowEnd, String fromId, String fromTs, String limit, String fields) Return a list of entities that match the given parameters.
org.apache.hadoop.yarn.api.records.timeline.TimelineEntity	getEntity(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String entityType, String entityId, String fields) Return a single entity of the given entity type and Id.
org.apache.hadoop.yarn.api.records.timeline.TimelineEvents	getEvents(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String entityType, String entityId, String eventType, String windowStart, String windowEnd, String limit) Return the events that match the given parameters.
org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse	postEntities(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.apache.hadoop.yarn.api.records.timeline.TimelineEntities entities) Store the given entities into the timeline store, and return the errors that happen during storing.
org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse	putDomain(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain) Store the given domain into the timeline store, and return the errors that happen during storing.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineWebServices

@Inject
public TimelineWebServices(TimelineDataManager timelineDataManager)

Method Detail

about

@GET
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineAbout about(@Context
                                                                                                                                javax.servlet.http.HttpServletRequest req,
                                                                                                                                @Context
                                                                                                                                javax.servlet.http.HttpServletResponse res)

Return the description of the timeline web services.

getEntities

@GET
 @Path(value="/{entityType}")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineEntities getEntities(@Context
                                                                                                                                                                       javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                       @Context
                                                                                                                                                                       javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                       @PathParam(value="entityType")
                                                                                                                                                                       String entityType,
                                                                                                                                                                       @QueryParam(value="primaryFilter")
                                                                                                                                                                       String primaryFilter,
                                                                                                                                                                       @QueryParam(value="secondaryFilter")
                                                                                                                                                                       String secondaryFilter,
                                                                                                                                                                       @QueryParam(value="windowStart")
                                                                                                                                                                       String windowStart,
                                                                                                                                                                       @QueryParam(value="windowEnd")
                                                                                                                                                                       String windowEnd,
                                                                                                                                                                       @QueryParam(value="fromId")
                                                                                                                                                                       String fromId,
                                                                                                                                                                       @QueryParam(value="fromTs")
                                                                                                                                                                       String fromTs,
                                                                                                                                                                       @QueryParam(value="limit")
                                                                                                                                                                       String limit,
                                                                                                                                                                       @QueryParam(value="fields")
                                                                                                                                                                       String fields)

Return a list of entities that match the given parameters.

getEntity

@GET
 @Path(value="/{entityType}/{entityId}")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineEntity getEntity(@Context
                                                                                                                                                                              javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                              @Context
                                                                                                                                                                              javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                              @PathParam(value="entityType")
                                                                                                                                                                              String entityType,
                                                                                                                                                                              @PathParam(value="entityId")
                                                                                                                                                                              String entityId,
                                                                                                                                                                              @QueryParam(value="fields")
                                                                                                                                                                              String fields)

Return a single entity of the given entity type and Id.

getEvents

@GET
 @Path(value="/{entityType}/events")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineEvents getEvents(@Context
                                                                                                                                                                          javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                          @Context
                                                                                                                                                                          javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                          @PathParam(value="entityType")
                                                                                                                                                                          String entityType,
                                                                                                                                                                          @QueryParam(value="entityId")
                                                                                                                                                                          String entityId,
                                                                                                                                                                          @QueryParam(value="eventType")
                                                                                                                                                                          String eventType,
                                                                                                                                                                          @QueryParam(value="windowStart")
                                                                                                                                                                          String windowStart,
                                                                                                                                                                          @QueryParam(value="windowEnd")
                                                                                                                                                                          String windowEnd,
                                                                                                                                                                          @QueryParam(value="limit")
                                                                                                                                                                          String limit)

Return the events that match the given parameters.

postEntities

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse postEntities(@Context
                                                                                                                                                                                   javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                   @Context
                                                                                                                                                                                   javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                                   org.apache.hadoop.yarn.api.records.timeline.TimelineEntities entities)

Store the given entities into the timeline store, and return the errors that happen during storing.

putDomain

@PUT
 @Path(value="/domain")
 @Consumes(value="application/json")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse putDomain(@Context
                                                                                                                                                                                                       javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                                       @Context
                                                                                                                                                                                                       javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                                                       org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain)

Store the given domain into the timeline store, and return the errors that happen during storing.

getDomain

@GET
 @Path(value="/domain/{domainId}")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineDomain getDomain(@Context
                                                                                                                                                                        javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                        @PathParam(value="domainId")
                                                                                                                                                                        String domainId)

Return a single domain of the given domain Id.

getDomains

@GET
 @Path(value="/domain")
 @Produces(value="application/json; charset=utf-8")
public org.apache.hadoop.yarn.api.records.timeline.TimelineDomains getDomains(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest req,
                                                                                                                                                               @Context
                                                                                                                                                               javax.servlet.http.HttpServletResponse res,
                                                                                                                                                               @QueryParam(value="owner")
                                                                                                                                                               String owner)

Return a list of domains of the given owner.