org.apache.druid.client.indexing

Interface IndexingServiceClient

All Known Implementing Classes:

HttpIndexingServiceClient

public interface IndexingServiceClient

High-level IndexingServiceClient client. New use cases should prefer OverlordClient.

Method Summary

Modifier and Type	Method and Description
String	cancelTask(String taskId)
String	compactSegments(String idPrefix, List<DataSegment> segments, int compactionTaskPriority, ClientCompactionTaskQueryTuningConfig tuningConfig, ClientCompactionTaskGranularitySpec granularitySpec, ClientCompactionTaskDimensionsSpec dimensionsSpec, AggregatorFactory[] metricsSpec, ClientCompactionTaskTransformSpec transformSpec, Boolean dropExisting, Map<String,Object> context)
List<TaskStatusPlus>	getActiveTasks() Gets all tasks that are waiting, pending, or running.
TaskStatusPlus	getLastCompleteTask()
Map<String,List<org.joda.time.Interval>>	getLockedIntervals(Map<String,Integer> minTaskPriority) Gets a List of Intervals locked by higher priority tasks for each datasource.
TaskPayloadResponse	getTaskPayload(String taskId)
Map<String,Object>	getTaskReport(String taskId)
TaskStatusResponse	getTaskStatus(String taskId)
int	getTotalWorkerCapacity() Gets the total worker capacity of the current state of the cluster.
int	getTotalWorkerCapacityWithAutoScale() Gets the total worker capacity of the cluster including auto scaling capability (scaling to max workers).
int	killPendingSegments(String dataSource, org.joda.time.DateTime end)
void	killUnusedSegments(String idPrefix, String dataSource, org.joda.time.Interval interval)
String	runTask(String taskId, Object taskObject)
SamplerResponse	sample(SamplerSpec samplerSpec)

Method Detail

killUnusedSegments

void killUnusedSegments(String idPrefix,
                        String dataSource,
                        org.joda.time.Interval interval)

killPendingSegments

int killPendingSegments(String dataSource,
                        org.joda.time.DateTime end)

compactSegments

String compactSegments(String idPrefix,
                       List<DataSegment> segments,
                       int compactionTaskPriority,
                       @Nullable
                       ClientCompactionTaskQueryTuningConfig tuningConfig,
                       @Nullable
                       ClientCompactionTaskGranularitySpec granularitySpec,
                       @Nullable
                       ClientCompactionTaskDimensionsSpec dimensionsSpec,
                       @Nullable
                       AggregatorFactory[] metricsSpec,
                       @Nullable
                       ClientCompactionTaskTransformSpec transformSpec,
                       @Nullable
                       Boolean dropExisting,
                       @Nullable
                       Map<String,Object> context)

getTotalWorkerCapacity

int getTotalWorkerCapacity()

Gets the total worker capacity of the current state of the cluster. This can be -1 if it cannot be determined.

getTotalWorkerCapacityWithAutoScale

int getTotalWorkerCapacityWithAutoScale()

Gets the total worker capacity of the cluster including auto scaling capability (scaling to max workers). This can be -1 if it cannot be determined or if auto scaling is not configured.

runTask

String runTask(String taskId,
               Object taskObject)

cancelTask

String cancelTask(String taskId)

getActiveTasks

List<TaskStatusPlus> getActiveTasks()

Gets all tasks that are waiting, pending, or running.

getTaskStatus

TaskStatusResponse getTaskStatus(String taskId)

getLastCompleteTask

@Nullable
TaskStatusPlus getLastCompleteTask()

getTaskPayload

@Nullable
TaskPayloadResponse getTaskPayload(String taskId)

getTaskReport

@Nullable
Map<String,Object> getTaskReport(String taskId)

getLockedIntervals

Map<String,List<org.joda.time.Interval>> getLockedIntervals(Map<String,Integer> minTaskPriority)

Gets a List of Intervals locked by higher priority tasks for each datasource.

Parameters:

minTaskPriority - Minimum task priority for each datasource. Only the Intervals that are locked by Tasks higher than this priority are returned. Tasks for datasources that are not present in this Map are not returned.

Returns:

Map from Datasource to List of Intervals locked by Tasks that have priority strictly greater than the minTaskPriority for that datasource.

sample

SamplerResponse sample(SamplerSpec samplerSpec)