MetadataTaskStorage (io.druid:druid 0.12.0 API)

java.lang.Object
- io.druid.indexing.overlord.MetadataTaskStorage

All Implemented Interfaces:: TaskStorage

public class MetadataTaskStorage
extends Object
implements TaskStorage

Constructor Summary

Constructors
Constructor and Description
`MetadataTaskStorage(MetadataStorageConnector metadataStorageConnector, TaskStorageConfig config, MetadataStorageActionHandlerFactory factory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`addAuditLog(Task task, TaskAction<T> taskAction)` Add an action taken by a task to the audit log.
`void`	`addLock(String taskid, TaskLock taskLock)` Persists lock state in the storage facility.
`List<Task>`	`getActiveTasks()` Returns a list of currently running or pending tasks as stored in the storage facility.
`List<TaskAction>`	`getAuditLogs(String taskId)` Returns all actions taken by a task.
`Pair<org.joda.time.DateTime,String>`	`getCreatedDateTimeAndDataSource(String taskId)`
`List<TaskLock>`	`getLocks(String taskid)` Returns a list of locks for a particular task.
`List<TaskStatus>`	`getRecentlyFinishedTaskStatuses(Integer maxTaskStatuses)` Returns up to `maxTaskStatuses` statuses of recently finished tasks as stored in the storage facility.
`com.google.common.base.Optional<TaskStatus>`	`getStatus(String taskId)` Returns task status as stored in the storage facility.
`com.google.common.base.Optional<Task>`	`getTask(String taskId)` Returns task as stored in the storage facility.
`void`	`insert(Task task, TaskStatus status)` Adds a task to the storage facility with a particular status.
`void`	`removeLock(String taskid, TaskLock taskLockToRemove)` Removes lock state from the storage facility.
`void`	`replaceLock(String taskid, TaskLock oldLock, TaskLock newLock)` Replace the old lock with the new lock.
`void`	`setStatus(TaskStatus status)` Persists task status in the storage facility.
`void`	`start()`
`void`	`stop()`

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

- Constructor Detail
  - MetadataTaskStorage
```
@Inject
public MetadataTaskStorage(MetadataStorageConnector metadataStorageConnector,
                                   TaskStorageConfig config,
                                   MetadataStorageActionHandlerFactory factory)
```
- Method Detail
  - start
```
public void start()
```
  - stop
```
public void stop()
```
  - insert
```
public void insert(Task task,
                   TaskStatus status)
            throws EntryExistsException
```
    Description copied from interface: TaskStorage
    
    Adds a task to the storage facility with a particular status.
    
    Specified by:
    
    insert in interface TaskStorage
    
    Parameters:
    
    task - task to add
    
    status - task status
    
    Throws:
    
    EntryExistsException - if the task ID already exists
  - setStatus
```
public void setStatus(TaskStatus status)
```
    Description copied from interface: TaskStorage
    
    Persists task status in the storage facility. This method should throw an exception if the task status lifecycle is not respected (absent -> RUNNING -> SUCCESS/FAILURE).
    
    Specified by:
    
    setStatus in interface TaskStorage
    
    Parameters:
    
    status - task status
  - getTask
```
public com.google.common.base.Optional<Task> getTask(String taskId)
```
    Description copied from interface: TaskStorage
    
    Returns task as stored in the storage facility. If the task ID does not exist, this will return an absentee Optional. NOTE: This method really feels like it should be combined with TaskStorage.getStatus(java.lang.String). Expect that in the future.
    
    Specified by:
    
    getTask in interface TaskStorage
    
    Parameters:
    
    taskId - task ID
    
    Returns:
    
    optional task
  - getStatus
```
public com.google.common.base.Optional<TaskStatus> getStatus(String taskId)
```
    Description copied from interface: TaskStorage
    
    Returns task status as stored in the storage facility. If the task ID does not exist, this will return an absentee Optional.
    
    Specified by:
    
    getStatus in interface TaskStorage
    
    Parameters:
    
    taskId - task ID
    
    Returns:
    
    task status
  - getActiveTasks
```
public List<Task> getActiveTasks()
```
    Description copied from interface: TaskStorage
    
    Returns a list of currently running or pending tasks as stored in the storage facility. No particular order is guaranteed, but implementations are encouraged to return tasks in ascending order of creation.
    
    Specified by:
    
    getActiveTasks in interface TaskStorage
    
    Returns:
    
    list of active tasks
  - getRecentlyFinishedTaskStatuses
```
public List<TaskStatus> getRecentlyFinishedTaskStatuses(@Nullable
                                                        Integer maxTaskStatuses)
```
    Description copied from interface: TaskStorage
    
    Returns up to maxTaskStatuses statuses of recently finished tasks as stored in the storage facility. No particular order is guaranteed, but implementations are encouraged to return tasks in descending order of creation. No particular standard of "recent" is guaranteed, and in fact, this method is permitted to simply return nothing.
    
    Specified by:
    
    getRecentlyFinishedTaskStatuses in interface TaskStorage
    
    Returns:
    
    list of recently finished tasks
  - getCreatedDateTimeAndDataSource
```
@Nullable
public Pair<org.joda.time.DateTime,String> getCreatedDateTimeAndDataSource(String taskId)
```
    Specified by:
    
    getCreatedDateTimeAndDataSource in interface TaskStorage
  - addLock
```
public void addLock(String taskid,
                    TaskLock taskLock)
```
    Description copied from interface: TaskStorage
    
    Persists lock state in the storage facility.
    
    Specified by:
    
    addLock in interface TaskStorage
    
    Parameters:
    
    taskid - task ID
    
    taskLock - lock state
  - replaceLock
```
public void replaceLock(String taskid,
                        TaskLock oldLock,
                        TaskLock newLock)
```
    Description copied from interface: TaskStorage
    
    Replace the old lock with the new lock. This method is not thread-safe.
    
    Specified by:
    
    replaceLock in interface TaskStorage
    
    Parameters:
    
    taskid - an id of the task holding the old lock and new lock
    
    oldLock - old lock
    
    newLock - new lock
  - removeLock
```
public void removeLock(String taskid,
                       TaskLock taskLockToRemove)
```
    Description copied from interface: TaskStorage
    
    Removes lock state from the storage facility. It is harmless to keep old locks in the storage facility, but this method can help reclaim wasted space.
    
    Specified by:
    
    removeLock in interface TaskStorage
    
    Parameters:
    
    taskid - task ID
    
    taskLockToRemove - lock state
  - getLocks
```
public List<TaskLock> getLocks(String taskid)
```
    Description copied from interface: TaskStorage
    
    Returns a list of locks for a particular task.
    
    Specified by:
    
    getLocks in interface TaskStorage
    
    Parameters:
    
    taskid - task ID
    
    Returns:
    
    list of TaskLocks for the given task
  - addAuditLog
```
public <T> void addAuditLog(Task task,
                            TaskAction<T> taskAction)
```
    Description copied from interface: TaskStorage
    
    Add an action taken by a task to the audit log.
    
    Specified by:
    
    addAuditLog in interface TaskStorage
    
    Type Parameters:
    
    T - task action return type
    
    Parameters:
    
    task - task to record action for
    
    taskAction - task action to record
  - getAuditLogs
```
public List<TaskAction> getAuditLogs(String taskId)
```
    Description copied from interface: TaskStorage
    
    Returns all actions taken by a task.
    
    Specified by:
    
    getAuditLogs in interface TaskStorage
    
    Parameters:
    
    taskId - task ID
    
    Returns:
    
    list of task actions

Class MetadataTaskStorage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetadataTaskStorage

Method Detail

start

stop

insert

setStatus

getTask

getStatus

getActiveTasks

getRecentlyFinishedTaskStatuses

getCreatedDateTimeAndDataSource

addLock

replaceLock

removeLock

getLocks

addAuditLog

getAuditLogs