Uses of Annotation Interface
org.apache.druid.guice.annotations.PublicApi

Packages that use PublicApi

Package	Description
org.apache.druid.data.input
org.apache.druid.data.input.impl
org.apache.druid.guice
org.apache.druid.guice.annotations
org.apache.druid.java.util.emitter.service
org.apache.druid.js
org.apache.druid.query
org.apache.druid.query.aggregation
org.apache.druid.query.cache
org.apache.druid.query.context
org.apache.druid.query.groupby
org.apache.druid.query.timeseries
org.apache.druid.query.topn
org.apache.druid.segment
org.apache.druid.segment.data
org.apache.druid.segment.loading
org.apache.druid.segment.serde
org.apache.druid.timeline
org.apache.druid.utils

Uses of PublicApi in org.apache.druid.data.input

Classes in org.apache.druid.data.input with annotations of type PublicApi

Modifier and Type	Class	Description
class	MapBasedInputRow
class	MapBasedRow
interface	Row	A Row of data.

Uses of PublicApi in org.apache.druid.data.input.impl

Classes in org.apache.druid.data.input.impl with annotations of type PublicApi

Modifier and Type	Class	Description
class	DimensionSchema	Defines the schema of a single dimension in a dataset.
class	DimensionsSpec
class	TimestampSpec

Methods in org.apache.druid.data.input.impl with annotations of type PublicApi

Modifier and Type	Method	Description
DimensionSchema	DimensionsSpec.getSchema(String dimension)
DimensionsSpec	DimensionsSpec.withDimensions(List<DimensionSchema> dims)

Uses of PublicApi in org.apache.druid.guice

Classes in org.apache.druid.guice with annotations of type PublicApi

Modifier and Type	Class	Description
class	Binders
class	ConditionalMultibind<T>	Provides the ability to conditionally bind an item to a set.
class	DruidGuiceExtensions
class	DruidScopes
class	Jerseys
class	JsonConfigProvider<T>	Provides a singleton value of type <T> from Properties bound in guice.
@interface	LazySingleton	A replacement for Guice's Singleton scope.
@interface	ManageLifecycle	Marks the object to be managed by Lifecycle and set to be on Lifecycle.Stage.NORMAL stage.
@interface	ManageLifecycleAnnouncements	Marks the object to be managed by Lifecycle and set to be on Lifecycle.Stage.ANNOUNCEMENTS stage.
@interface	ManageLifecycleInit	Marks the object to be managed by Lifecycle and set to be on Lifecycle.Stage.INIT stage.
@interface	ManageLifecycleServer	Marks the object to be managed by Lifecycle and set to be on Lifecycle.Stage.SERVER stage.
class	PolyBind	Provides the ability to create "polymorphic" bindings where the polymorphism is actually just making a decision based on a value in Properties.

Methods in org.apache.druid.guice with annotations of type PublicApi

Modifier and Type	Method	Description
ConditionalMultibind<T>	ConditionalMultibind.addConditionBinding(String property, com.google.common.base.Predicate<String> condition, com.google.inject.TypeLiteral<T> target)	Conditionally bind target to the set.

Uses of PublicApi in org.apache.druid.guice.annotations

Classes in org.apache.druid.guice.annotations with annotations of type PublicApi

Modifier and Type	Class	Description
@interface	EscalatedGlobal
@interface	Global
@interface	Json
@interface	JsonNonNull	The ObjectMapper of this annotation will skip serialization of any field with null value.
@interface	JSR311Resource
@interface	Parent	Binding annotation for org.apache.druid.server.DruidNode.
@interface	Self	Binding annotation for org.apache.druid.server.DruidNode.
@interface	Smile

Uses of PublicApi in org.apache.druid.java.util.emitter.service

Classes in org.apache.druid.java.util.emitter.service with annotations of type PublicApi

Modifier and Type	Class	Description
class	AlertEvent
class	ServiceMetricEvent	Immutable metric event emitted by a Druid ServiceEmitter.

Uses of PublicApi in org.apache.druid.js

Classes in org.apache.druid.js with annotations of type PublicApi

Modifier and Type	Class	Description
class	JavaScriptConfig	Should be used by extension filters, aggregators, etc, that use JavaScript to determine if JavaScript is enabled or not.

Uses of PublicApi in org.apache.druid.query

Classes in org.apache.druid.query with annotations of type PublicApi

Modifier and Type	Interface	Description
interface	BySegmentResultValue<T>
interface	GenericQueryMetricsFactory	This factory is used for DI of custom QueryMetrics implementations for all query types, which don't (yet) need to emit custom dimensions and/or metrics, i.
class	Queries
class	QueryContexts
final class	QueryPlus<T>	An immutable composite object of Query + extra stuff needed in QueryRunners.
class	Result<T>
class	ResultGranularTimestampComparator<T>
class	ResultMergeQueryRunner<T>

Methods in org.apache.druid.query with annotations of type PublicApi

Modifier and Type	Method	Description
void	QueryMetrics.context(QueryType query)	Sets Query.getContext() of the given query as dimension.
void	QueryMetrics.dataSource(QueryType query)	Sets Query.getDataSource() of the given query as dimension.
void	QueryMetrics.duration(QueryType query)	Sets Query.getDuration() of the given query as dimension.
void	QueryMetrics.hasFilters(QueryType query)	Sets Query.hasFilters() of the given query as dimension.
void	QueryMetrics.interval(QueryType query)	Sets Query.getIntervals() of the given query as dimension.
void	QueryMetrics.queryId(String queryId)	Sets id of the given query as dimension.
void	QueryMetrics.queryId(QueryType query)	Sets Query.getId() of the given query as dimension.
void	QueryMetrics.queryType(QueryType query)	Sets Query.getType() of the given query as dimension.
void	QueryMetrics.sqlQueryId(String sqlQueryId)	Sets sqlQueryId as a dimension
void	QueryMetrics.sqlQueryId(QueryType query)	Sets Query.getSqlQueryId() of the given query as dimension
void	QueryMetrics.subQueryId(QueryType query)	Sets Query.getSubQueryId() of the given query as dimension.

Uses of PublicApi in org.apache.druid.query.aggregation

Classes in org.apache.druid.query.aggregation with annotations of type PublicApi

Modifier and Type	Class	Description
class	AggregatorUtil
interface	MetricManipulationFn
final class	NullableNumericAggregateCombiner<T>	Null-aware numeric AggregateCombiner.
final class	NullableNumericAggregator	Null-aware numeric Aggregator.
final class	NullableNumericBufferAggregator	Null-aware numeric BufferAggregator.

Uses of PublicApi in org.apache.druid.query.cache

Classes in org.apache.druid.query.cache with annotations of type PublicApi

Modifier and Type	Class	Description
class	CacheKeyBuilder	CacheKeyBuilder is a tool for easily generating cache keys of Cacheable objects.

Uses of PublicApi in org.apache.druid.query.context

Classes in org.apache.druid.query.context with annotations of type PublicApi

Modifier and Type	Class	Description
class	ConcurrentResponseContext	The implementation of ResponseContext with a ConcurrentHashMap as a delegate
class	DefaultResponseContext	The implementation of ResponseContext with a HashMap as a delegate
class	ResponseContext	The context for storing and passing data between chains of QueryRunners.

Uses of PublicApi in org.apache.druid.query.groupby

Methods in org.apache.druid.query.groupby with annotations of type PublicApi

Modifier and Type	Method	Description
void	GroupByQueryMetrics.granularity(GroupByQuery query)	Sets the granularity of BaseQuery.getGranularity() of the given query as dimension.
void	GroupByQueryMetrics.numComplexMetrics(GroupByQuery query)	Sets the number of "complex" metrics of the given groupBy query as dimension.
void	GroupByQueryMetrics.numDimensions(GroupByQuery query)	Sets the size of GroupByQuery.getDimensions() of the given query as dimension.
void	GroupByQueryMetrics.numMetrics(GroupByQuery query)	Sets the number of metrics of the given groupBy query as dimension.

Uses of PublicApi in org.apache.druid.query.timeseries

Methods in org.apache.druid.query.timeseries with annotations of type PublicApi

Modifier and Type	Method	Description
void	TimeseriesQueryMetrics.granularity(TimeseriesQuery query)	Sets the granularity of BaseQuery.getGranularity() of the given query as dimension.
void	TimeseriesQueryMetrics.limit(TimeseriesQuery query)	Sets TimeseriesQuery.getLimit() of the given query as dimension.
void	TimeseriesQueryMetrics.numComplexMetrics(TimeseriesQuery query)	Sets the number of "complex" metrics of the given timeseries query as dimension.
void	TimeseriesQueryMetrics.numMetrics(TimeseriesQuery query)	Sets the number of metrics of the given timeseries query as dimension.

Uses of PublicApi in org.apache.druid.query.topn

Methods in org.apache.druid.query.topn with annotations of type PublicApi

Modifier and Type	Method	Description
TopNQueryMetrics	TopNQueryMetrics.addProcessedRows(long numRows)	Called with the number of rows, processed via each cursor, processed for the query within the segment.
void	TopNQueryMetrics.algorithm(TopNAlgorithm algorithm)
void	TopNQueryMetrics.columnValueSelector(ColumnValueSelector columnValueSelector)	This method is called exactly once with the columnValueSelector object of each cursor, processed for the query.
void	TopNQueryMetrics.cursor(Cursor cursor)	This method is called exactly once with each cursor, processed for the query.
void	TopNQueryMetrics.dimension(TopNQuery query)	Sets TopNQuery.getDimensionSpec().getDimension() of the given query as dimension.
void	TopNQueryMetrics.dimensionCardinality(int cardinality)
void	TopNQueryMetrics.granularity(TopNQuery query)	Sets the granularity of BaseQuery.getGranularity() of the given query as dimension.
void	TopNQueryMetrics.numComplexMetrics(TopNQuery query)	Sets the number of "complex" metrics of the given topN query as dimension.
void	TopNQueryMetrics.numMetrics(TopNQuery query)	Sets the number of metrics of the given topN query as dimension.
void	TopNQueryMetrics.numValuesPerPass(TopNParams params)	This method may set TopNParams.getNumValuesPerPass() of the query as dimension.
void	TopNQueryMetrics.threshold(TopNQuery query)	Sets TopNQuery.getThreshold() of the given query as dimension.

Uses of PublicApi in org.apache.druid.segment

Classes in org.apache.druid.segment with annotations of type PublicApi

Modifier and Type	Interface	Description
interface	BaseNullableColumnValueSelector	Null value checking polymorphic "part" of the ColumnValueSelector interface for primitive values.
interface	ColumnSelectorFactory	Factory class for MetricSelectors
interface	DimensionSelector	Selector for a string-typed column, either single- or multi-valued.
class	Metadata
class	NilColumnValueSelector	Represents "absent" column.
interface	Segment	The difference between this class and DataSegment is that DataSegment contains the segment metadata only, while this class represents the actual body of segment data, queryable.
class	SegmentUtils	Utility methods useful for implementing deep storage extensions.

Uses of PublicApi in org.apache.druid.segment.data

Classes in org.apache.druid.segment.data with annotations of type PublicApi

Modifier and Type	Interface	Description
interface	Indexed<T>	Indexed is a fixed-size, immutable, indexed set of values which allows locating a specific index via an exact match, the semantics of which are defined by the implementation.
interface	IndexedInts	Get a int an index (array or list lookup abstraction without boxing).

Uses of PublicApi in org.apache.druid.segment.loading

Classes in org.apache.druid.segment.loading with annotations of type PublicApi

Modifier and Type	Class	Description
class	SegmentLoadingException

Uses of PublicApi in org.apache.druid.segment.serde

Methods in org.apache.druid.segment.serde with annotations of type PublicApi

Modifier and Type	Method	Description
static ComplexColumnSerializer	ComplexColumnSerializer.create(SegmentWriteOutMedium segmentWriteOutMedium, String filenameBase, ObjectStrategy strategy)
static <T> LargeColumnSupportedComplexColumnSerializer<T>	LargeColumnSupportedComplexColumnSerializer.create(SegmentWriteOutMedium segmentWriteOutMedium, String filenameBase, ObjectStrategy strategy)

Uses of PublicApi in org.apache.druid.timeline

Classes in org.apache.druid.timeline with annotations of type PublicApi

Modifier and Type	Class	Description
class	DataSegment	Metadata of Druid's data segment.
interface	LogicalSegment	A logical segment can represent an entire segment or a part of a segment.
final class	SegmentId	Identifier of DataSegment.

Uses of PublicApi in org.apache.druid.utils

Classes in org.apache.druid.utils with annotations of type PublicApi

Modifier and Type	Class	Description
class	CompressionUtils
class	Runnables