io.druid.indexing.common.task

Class IndexTask

java.lang.Object

io.druid.indexing.common.task.AbstractTask

io.druid.indexing.common.task.IndexTask

All Implemented Interfaces:

Task

public class IndexTask
extends AbstractTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexTask.IndexIngestionSpec
static class	IndexTask.IndexIOConfig
static class	IndexTask.IndexTuningConfig

Constructor Summary

Constructors

Constructor and Description
IndexTask(String id, TaskResource taskResource, IndexTask.IndexIngestionSpec ingestionSchema, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
IndexTask.IndexIngestionSpec	getIngestionSchema()
int	getPriority() Returns task priority.
String	getType() Returns a descriptive label for this task type.
boolean	isReady(TaskActionClient taskActionClient) Execute preflight actions for a task.
TaskStatus	run(TaskToolbox toolbox) Execute a task.

Methods inherited from class io.druid.indexing.common.task.AbstractTask

canRestore, equals, getClasspathPrefix, getContext, getDataSource, getGroupId, getId, getNodeType, getQueryRunner, getTaskResource, hashCode, stopGracefully, success, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.druid.indexing.common.task.Task

getContextValue, getContextValue

Constructor Detail

IndexTask

public IndexTask(String id,
                 TaskResource taskResource,
                 IndexTask.IndexIngestionSpec ingestionSchema,
                 Map<String,Object> context)

Method Detail

getPriority

public int getPriority()

Description copied from interface: Task

Returns task priority. The task priority is currently used only for prioritized locking, but, in the future, it can be used for task scheduling, cluster resource management, etc.

Returns:

task priority

See Also:

for default task priorities

getType

public String getType()

Description copied from interface: Task

Returns a descriptive label for this task type. Used for metrics emission and logging.

Returns:

task type label

isReady

public boolean isReady(TaskActionClient taskActionClient)
                throws Exception

Description copied from interface: Task

Execute preflight actions for a task. This can be used to acquire locks, check preconditions, and so on. The actions must be idempotent, since this method may be executed multiple times. This typically runs on the coordinator. If this method throws an exception, the task should be considered a failure.

This method must be idempotent, as it may be run multiple times per task.

Parameters:

taskActionClient - action client for this task (not the full toolbox)

Returns:

true if ready, false if not ready yet

Throws:

Exception - if the task should be considered a failure

getIngestionSchema

public IndexTask.IndexIngestionSpec getIngestionSchema()

run

public TaskStatus run(TaskToolbox toolbox)
               throws Exception

Description copied from interface: Task

Execute a task. This typically runs on a worker as determined by a TaskRunner, and will be run while holding a lock on our dataSource and implicit lock interval (if any). If this method throws an exception, the task should be considered a failure.

Parameters:

toolbox - Toolbox for this task

Returns:

Some kind of finished status (isRunnable must be false).

Throws:

Exception - if this task failed