java.lang.Object
- org.apache.druid.server.http.MetadataResource

public class MetadataResource
extends Object

Constructor Summary

Constructors
Constructor	Description
`MetadataResource(SegmentsMetadataManager segmentsMetadataManager, IndexerMetadataStorageCoordinator metadataStorageCoordinator, AuthorizerMapper authorizerMapper, DruidCoordinator coordinator, CoordinatorSegmentMetadataCache coordinatorSegmentMetadataCache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`getAllUsedSegments(javax.servlet.http.HttpServletRequest req, Set<String> dataSources, String includeOvershadowedStatus, String includeRealtimeSegments)`
`javax.ws.rs.core.Response`	`getDataSourceInformation(javax.servlet.http.HttpServletRequest req, List<String> dataSources)`	API to fetch `DataSourceInformation` for the specified datasources.
`javax.ws.rs.core.Response`	`getDataSources(String full, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest req)`
`javax.ws.rs.core.Response`	`getDataSourceWithUsedSegments(String dataSourceName)`	The difference of this method from `getUsedSegmentsInDataSource(java.lang.String, java.lang.String)` is that the latter returns only a list of segments, while this method also includes the properties of data source, such as the time when it was created.
`javax.ws.rs.core.Response`	`getSegment(String dataSourceName, String segmentId, Boolean includeUnused)`
`javax.ws.rs.core.Response`	`getUnusedSegmentsInDataSource(javax.servlet.http.HttpServletRequest req, String dataSource, String interval, Integer limit, String lastSegmentId, String sortOrder)`
`javax.ws.rs.core.Response`	`getUsedSegmentsInDataSource(String dataSourceName, String full)`
`javax.ws.rs.core.Response`	`getUsedSegmentsInDataSourceForIntervals(String dataSourceName, String full, List<org.joda.time.Interval> intervals)`	This is a `POST` method to pass the list of intervals in the body, see https://github.com/apache/druid/pull/2109#issuecomment-182191258

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataResource

@Inject
public MetadataResource(SegmentsMetadataManager segmentsMetadataManager,
                        IndexerMetadataStorageCoordinator metadataStorageCoordinator,
                        AuthorizerMapper authorizerMapper,
                        DruidCoordinator coordinator,
                        @Nullable
                        CoordinatorSegmentMetadataCache coordinatorSegmentMetadataCache)

Method Detail

getDataSources

public javax.ws.rs.core.Response getDataSources(String full,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.servlet.http.HttpServletRequest req)

getAllUsedSegments

public javax.ws.rs.core.Response getAllUsedSegments(@Context
                                                    javax.servlet.http.HttpServletRequest req,
                                                    @Nullable
                                                    Set<String> dataSources,
                                                    @Nullable
                                                    String includeOvershadowedStatus,
                                                    @Nullable
                                                    String includeRealtimeSegments)

getDataSourceWithUsedSegments
```
public javax.ws.rs.core.Response getDataSourceWithUsedSegments(String dataSourceName)
```
The difference of this method from getUsedSegmentsInDataSource(java.lang.String, java.lang.String) is that the latter returns only a list of segments, while this method also includes the properties of data source, such as the time when it was created.

getUsedSegmentsInDataSource

public javax.ws.rs.core.Response getUsedSegmentsInDataSource(String dataSourceName,
                                                             @Nullable
                                                             String full)

getUsedSegmentsInDataSourceForIntervals

public javax.ws.rs.core.Response getUsedSegmentsInDataSourceForIntervals(String dataSourceName,
                                                                         @Nullable
                                                                         String full,
                                                                         List<org.joda.time.Interval> intervals)

This is a POST method to pass the list of intervals in the body, see https://github.com/apache/druid/pull/2109#issuecomment-182191258

getUnusedSegmentsInDataSource

public javax.ws.rs.core.Response getUnusedSegmentsInDataSource(@Context
                                                               javax.servlet.http.HttpServletRequest req,
                                                               String dataSource,
                                                               @Nullable
                                                               String interval,
                                                               @Nullable
                                                               Integer limit,
                                                               @Nullable
                                                               String lastSegmentId,
                                                               @Nullable
                                                               String sortOrder)

getSegment

public javax.ws.rs.core.Response getSegment(String dataSourceName,
                                            String segmentId,
                                            @Nullable
                                            Boolean includeUnused)

getDataSourceInformation

public javax.ws.rs.core.Response getDataSourceInformation(@Context
                                                          javax.servlet.http.HttpServletRequest req,
                                                          List<String> dataSources)

API to fetch DataSourceInformation for the specified datasources.

Parameters:: dataSources - list of dataSources to be queried
Returns:: information including schema details for the specified datasources

Class MetadataResource