Package org.apache.hadoop.yarn.server.timelineservice.storage.reader

Class TimelineEntityReaderFactory

java.lang.Object
org.apache.hadoop.yarn.server.timelineservice.storage.reader.TimelineEntityReaderFactory
public final class TimelineEntityReaderFactory extends Object
Factory methods for instantiating a timeline entity reader.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EntityTypeReader
    createEntityTypeReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)
    Creates a timeline entity type reader that will read all available entity types within the specified context.
    static TimelineEntityReader
    createMultipleEntitiesReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters filters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)
    Creates a timeline entity reader instance for reading set of entities with the specified input and predicates.
    static TimelineEntityReader
    createSingleEntityReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)
    Creates a timeline entity reader instance for reading a single entity with the specified input.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • createSingleEntityReader

      public static TimelineEntityReader createSingleEntityReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)
      Creates a timeline entity reader instance for reading a single entity with the specified input.
      Parameters:
      context - Reader context which defines the scope in which query has to be made.
      dataToRetrieve - Data to retrieve for each entity.
      Returns:
      An implementation of TimelineEntityReader object depending on entity type.

    • createMultipleEntitiesReader

      public static TimelineEntityReader createMultipleEntitiesReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters filters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)
      Creates a timeline entity reader instance for reading set of entities with the specified input and predicates.
      Parameters:
      context - Reader context which defines the scope in which query has to be made.
      filters - Filters which limit the entities returned.
      dataToRetrieve - Data to retrieve for each entity.
      Returns:
      An implementation of TimelineEntityReader object depending on entity type.

    • createEntityTypeReader

      public static EntityTypeReader createEntityTypeReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)
      Creates a timeline entity type reader that will read all available entity types within the specified context.
      Parameters:
      context - Reader context which defines the scope in which query has to be made. Limited to application level only.
      Returns:
      an EntityTypeReader object