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

Class TimelineWebServices

java.lang.Object
org.apache.hadoop.yarn.server.timeline.webapp.TimelineWebServices
@Singleton @Path("/ws/v1/timeline") public class TimelineWebServices extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimelineWebServices(TimelineDataManager timelineDataManager)
     

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • TimelineWebServices

      @Inject public TimelineWebServices(TimelineDataManager timelineDataManager)

  • Method Details

    • about

      @GET @Produces("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("/{entityType}") @Consumes("application/json") @Produces("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("entityType") String entityType, @QueryParam("primaryFilter") String primaryFilter, @QueryParam("secondaryFilter") String secondaryFilter, @QueryParam("windowStart") String windowStart, @QueryParam("windowEnd") String windowEnd, @QueryParam("fromId") String fromId, @QueryParam("fromTs") String fromTs, @QueryParam("limit") String limit, @QueryParam("fields") String fields)
      Return a list of entities that match the given parameters.

    • getEntity

      @GET @Path("/{entityType}/{entityId}") @Consumes("application/json") @Produces("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("entityType") String entityType, @PathParam("entityId") String entityId, @QueryParam("fields") String fields)
      Return a single entity of the given entity type and Id.

    • getEvents

      @GET @Path("/{entityType}/events") @Produces("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("entityType") String entityType, @QueryParam("entityId") String entityId, @QueryParam("eventType") String eventType, @QueryParam("windowStart") String windowStart, @QueryParam("windowEnd") String windowEnd, @QueryParam("limit") String limit)
      Return the events that match the given parameters.

    • postEntities

      @POST @Consumes("application/json") @Produces("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. We’re migrating to Jersey2. Previously, using `TimelineEntities` and converting to JSON via `JAXBContext` led to type conversion issues. Therefore, we’ve changed the method parameter to `String`, passing JSON directly and performing deserialization here.

    • putDomain

      @PUT @Path("/domain") @Consumes("application/json") @Produces("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("/domain/{domainId}") @Produces("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("domainId") String domainId)
      Return a single domain of the given domain Id.

    • getDomains

      @GET @Path("/domain") @Produces("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("owner") String owner)
      Return a list of domains of the given owner.