io.druid.indexing.common.task

Class RealtimeIndexTask

java.lang.Object

io.druid.indexing.common.task.AbstractTask

io.druid.indexing.common.task.RealtimeIndexTask

All Implemented Interfaces:

Task

public class RealtimeIndexTask
extends AbstractTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealtimeIndexTask.TaskActionSegmentPublisher

Field Summary

Fields

Modifier and Type	Field and Description
static String	CTX_KEY_LOOKUP_TIER

Constructor Summary

Constructors

Constructor and Description
RealtimeIndexTask(String id, TaskResource taskResource, FireDepartment fireDepartment, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
boolean	canRestore() Returns whether or not this task can restore its progress from its on-disk working directory.
Firehose	getFirehose() Public for tests.
FireDepartmentMetrics	getMetrics() Public for tests.
String	getNodeType() Get the nodeType for if/when this task publishes on zookeeper.
int	getPriority() Returns task priority.
<T> QueryRunner<T>	getQueryRunner(Query<T> query) Returns query runners for this task.
FireDepartment	getRealtimeIngestionSchema()
String	getType() Returns a descriptive label for this task type.
protected boolean	isFirehoseDrainableByClosing(FirehoseFactory firehoseFactory) Is a firehose from this factory drainable by closing it? If so, we should drain on stopGracefully rather than abruptly stopping.
boolean	isReady(TaskActionClient taskActionClient) Execute preflight actions for a task.
TaskStatus	run(TaskToolbox toolbox) Execute a task.
void	stopGracefully() Asks a task to arrange for its "run" method to exit promptly.

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

equals, getClasspathPrefix, getContext, getDataSource, getGroupId, getId, getTaskResource, hashCode, 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

Field Detail

CTX_KEY_LOOKUP_TIER

public static final String CTX_KEY_LOOKUP_TIER

See Also:

Constant Field Values

Constructor Detail

RealtimeIndexTask

public RealtimeIndexTask(String id,
                         TaskResource taskResource,
                         FireDepartment fireDepartment,
                         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

getNodeType

public String getNodeType()

Description copied from interface: Task

Get the nodeType for if/when this task publishes on zookeeper.

Specified by:

getNodeType in interface Task

Overrides:

getNodeType in class AbstractTask

Returns:

the nodeType to use when publishing the server to zookeeper. null if the task doesn't expect to publish to zookeeper.

getQueryRunner

public <T> QueryRunner<T> getQueryRunner(Query<T> query)

Description copied from interface: Task

Returns query runners for this task. If this task is not meant to answer queries over its datasource, this method should return null.

Specified by:

getQueryRunner in interface Task

Overrides:

getQueryRunner in class AbstractTask

Type Parameters:

T - query result type

Returns:

query runners for this task

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

canRestore

public boolean canRestore()

Description copied from interface: Task

Returns whether or not this task can restore its progress from its on-disk working directory. Restorable tasks may be started with a non-empty working directory. Tasks that exit uncleanly may still have a chance to attempt restores, meaning that restorable tasks should be able to deal with potentially partially written on-disk state.

Specified by:

canRestore in interface Task

Overrides:

canRestore in class AbstractTask

stopGracefully

public void stopGracefully()

Description copied from interface: Task

Asks a task to arrange for its "run" method to exit promptly. This method will only be called if Task.canRestore() returns true. Tasks that take too long to stop gracefully will be terminated with extreme prejudice.

Specified by:

stopGracefully in interface Task

Overrides:

stopGracefully in class AbstractTask

getFirehose

public Firehose getFirehose()

Public for tests.

getMetrics

public FireDepartmentMetrics getMetrics()

Public for tests.

getRealtimeIngestionSchema

public FireDepartment getRealtimeIngestionSchema()

isFirehoseDrainableByClosing

protected boolean isFirehoseDrainableByClosing(FirehoseFactory firehoseFactory)

Is a firehose from this factory drainable by closing it? If so, we should drain on stopGracefully rather than abruptly stopping. This is a hack to get around the fact that the Firehose and FirehoseFactory interfaces do not help us do this. Protected for tests.