io.druid.indexing.common.task

Class NoopTask

java.lang.Object

io.druid.indexing.common.task.AbstractTask

io.druid.indexing.common.task.NoopTask

All Implemented Interfaces:

Task

public class NoopTask
extends AbstractTask

Constructor Summary

Constructors

Constructor and Description
NoopTask(String id, String dataSource, long runTime, long isReadyTime, String isReadyResult, FirehoseFactory firehoseFactory, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
static NoopTask	create()
static NoopTask	create(int priority)
static NoopTask	create(String dataSource)
static NoopTask	create(String id, int priority)
FirehoseFactory	getFirehoseFactory()
io.druid.indexing.common.task.NoopTask.IsReadyResult	getIsReadyResult()
long	getIsReadyTime()
long	getRunTime()
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, getPriority

Constructor Detail

NoopTask

public NoopTask(String id,
                String dataSource,
                long runTime,
                long isReadyTime,
                String isReadyResult,
                FirehoseFactory firehoseFactory,
                Map<String,Object> context)

Method Detail

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

getRunTime

public long getRunTime()

getIsReadyTime

public long getIsReadyTime()

getIsReadyResult

public io.druid.indexing.common.task.NoopTask.IsReadyResult getIsReadyResult()

getFirehoseFactory

public FirehoseFactory getFirehoseFactory()

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

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

create

public static NoopTask create()

create

public static NoopTask create(String dataSource)

create

public static NoopTask create(int priority)

create

public static NoopTask create(String id,
                              int priority)