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

Interface DocumentStoreReader<Document extends TimelineDocument>

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

CosmosDBDocumentStoreReader

public interface DocumentStoreReader<Document extends TimelineDocument>
extends java.lang.AutoCloseable

Every DocumentStoreVendor have to implement this for creating reader to its backend.

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	fetchEntityTypes(java.lang.String collectionName, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)
Document	readDocument(java.lang.String collectionName, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, java.lang.Class<Document> documentClass)
java.util.List<Document>	readDocumentList(java.lang.String collectionName, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context, java.lang.Class<Document> documentClass, long documentsSize)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

readDocument

Document readDocument(java.lang.String collectionName,
                      org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context,
                      java.lang.Class<Document> documentClass)
               throws NoDocumentFoundException

Throws:

NoDocumentFoundException

readDocumentList

java.util.List<Document> readDocumentList(java.lang.String collectionName,
                                          org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context,
                                          java.lang.Class<Document> documentClass,
                                          long documentsSize)
                                   throws NoDocumentFoundException

Throws:

NoDocumentFoundException

fetchEntityTypes

java.util.Set<java.lang.String> fetchEntityTypes(java.lang.String collectionName,
                                                 org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext context)