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

Class EntityTypeReader

java.lang.Object

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

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

public final class EntityTypeReader
extends AbstractTimelineStorageReader

Timeline entity reader for listing all available entity types given one reader context. Right now only supports listing all entity types within one YARN application.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader

AbstractTimelineStorageReader.FlowContext

Constructor Summary

Constructors

Constructor	Description
EntityTypeReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	readEntityTypes(org.apache.hadoop.conf.Configuration hbaseConf, org.apache.hadoop.hbase.client.Connection conn)	Reads a set of timeline entity types from the HBase storage for the given context.
protected void	validateParams()	Validates the required parameters to read the entities.

Methods inherited from class org.apache.hadoop.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader

augmentParams, defaultAugmentParams, getContext, lookupFlowContext

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityTypeReader

public EntityTypeReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)

Method Detail

readEntityTypes

public java.util.Set<java.lang.String> readEntityTypes(org.apache.hadoop.conf.Configuration hbaseConf,
                                                       org.apache.hadoop.hbase.client.Connection conn)
                                                throws java.io.IOException

Reads a set of timeline entity types from the HBase storage for the given context.

Parameters:

hbaseConf - HBase Configuration.

conn - HBase Connection.

Returns:

a set of TimelineEntity objects, with only type field set.

Throws:

java.io.IOException - if any exception is encountered while reading entities.

validateParams

protected void validateParams()

Description copied from class: AbstractTimelineStorageReader

Validates the required parameters to read the entities.

Specified by:

validateParams in class AbstractTimelineStorageReader