@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class TimelineReaderManager
extends org.apache.hadoop.service.AbstractService
| Constructor and Description | 
|---|
| TimelineReaderManager(TimelineReader timelineReader) | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI)The API to confirm is a User is allowed to read this data. | 
| Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> | getEntities(TimelineReaderContext context,
           TimelineEntityFilters filters,
           TimelineDataToRetrieve dataToRetrieve)Get a set of entities matching given predicates by making a call to
 backend storage implementation. | 
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity | getEntity(TimelineReaderContext context,
         TimelineDataToRetrieve dataToRetrieve)Get single timeline entity by making a call to backend storage
 implementation. | 
| Set<String> | getEntityTypes(TimelineReaderContext context)Gets a list of available timeline entity types for an application. | 
| org.apache.hadoop.yarn.api.records.timeline.TimelineHealth | getHealthStatus()Check if reader connection is alive. | 
| protected void | serviceInit(org.apache.hadoop.conf.Configuration conf) | 
close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStart, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStoppublic TimelineReaderManager(TimelineReader timelineReader)
protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception
serviceInit in class org.apache.hadoop.service.AbstractServiceExceptionpublic Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getEntities(TimelineReaderContext context, TimelineEntityFilters filters, TimelineDataToRetrieve dataToRetrieve) throws IOException
TimelineReader.getEntities(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve).If cluster ID
 has not been supplied by the client, fills the cluster id from config
 before making a call to backend storage. After fetching entities from
 backend, fills the appropriate UID based on entity type for each entity.context - Timeline context within the scope of which entities have to
     be fetched.filters - Filters which limit the number of entities to be returned.dataToRetrieve - Data to carry in each entity fetched.IOException - if any problem occurs while getting entities.TimelineReader.getEntities(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(TimelineReaderContext context, TimelineDataToRetrieve dataToRetrieve) throws IOException
TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve). If cluster ID has not
 been supplied by the client, fills the cluster id from config before making
 a call to backend storage. After fetching entity from backend, fills the
 appropriate UID based on entity type.context - Timeline context within the scope of which entity has to be
     fetched.dataToRetrieve - Data to carry in the entity fetched.IOException - if any problem occurs while getting entity.TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)public Set<String> getEntityTypes(TimelineReaderContext context) throws IOException
TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve).
 If cluster ID has not been supplied by the client, fills the cluster id
 from config before making a call to backend storage.context - Timeline context within the scope of which entity types
                have to be fetched. Entity type field of this context should
                be null.IOException - if any problem occurs while getting entity types.public boolean checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI)
callerUGI - UserGroupInformation of the userpublic org.apache.hadoop.yarn.api.records.timeline.TimelineHealth getHealthStatus()
Copyright © 2008–2023 Apache Software Foundation. All rights reserved.