MonitoredTask (Apache HBase 2.4.0 API)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

MonitoredRPCHandler

All Known Implementing Classes:

MonitoredRPCHandlerImpl, MonitoredTaskImpl
```
@InterfaceAudience.Private
public interface MonitoredTask
extends Cloneable
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MonitoredTask.State

static interface MonitoredTask.StatusJournalEntry

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MonitoredTask.State`
`static interface`	`MonitoredTask.StatusJournalEntry`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`abort(String msg)`
`void`	`cleanup()` Explicitly mark this status as able to be cleaned up, even though it might not be complete.
`MonitoredTask`	`clone()` Public exposure of Object.clone() in order to allow clients to easily capture current state.
`void`	`disableStatusJournal()`
`void`	`enableStatusJournal(boolean includeCurrentStatus)` Enable journal that will store all statuses that have been set along with the time stamps when they were set.
`void`	`expireNow()`
`long`	`getCompletionTimestamp()`
`String`	`getDescription()`
`long`	`getStartTime()`
`MonitoredTask.State`	`getState()`
`long`	`getStateTime()`
`String`	`getStatus()`
`List<MonitoredTask.StatusJournalEntry>`	`getStatusJournal()`
`long`	`getStatusTime()`
`long`	`getWarnTime()`
`void`	`markComplete(String msg)`
`void`	`pause(String msg)`
`String`	`prettyPrintJournal()`
`void`	`resume(String msg)`
`void`	`setDescription(String description)`
`void`	`setStatus(String status)`
`void`	`setWarnTime(long t)`
`String`	`toJSON()` Creates a JSON object for parseable exposure of monitored tasks.
`Map<String,Object>`	`toMap()` Creates a string map of internal details for extensible exposure of monitored tasks.

- Method Detail
  - getStartTime
```
long getStartTime()
```
  - getDescription
```
String getDescription()
```
  - getStatus
```
String getStatus()
```
  - getStatusTime
```
long getStatusTime()
```
  - getState
```
MonitoredTask.State getState()
```
  - getStateTime
```
long getStateTime()
```
  - getCompletionTimestamp
```
long getCompletionTimestamp()
```
  - getWarnTime
```
long getWarnTime()
```
  - markComplete
```
void markComplete(String msg)
```
  - pause
```
void pause(String msg)
```
  - resume
```
void resume(String msg)
```
  - abort
```
void abort(String msg)
```
  - expireNow
```
void expireNow()
```
  - setStatus
```
void setStatus(String status)
```
  - setDescription
```
void setDescription(String description)
```
  - setWarnTime
```
void setWarnTime(long t)
```
  - getStatusJournal
```
List<MonitoredTask.StatusJournalEntry> getStatusJournal()
```
  - enableStatusJournal
```
void enableStatusJournal(boolean includeCurrentStatus)
```
    Enable journal that will store all statuses that have been set along with the time stamps when they were set.
    
    Parameters:
    
    includeCurrentStatus - whether to include the current set status in the journal
  - disableStatusJournal
```
void disableStatusJournal()
```
  - prettyPrintJournal
```
String prettyPrintJournal()
```
  - cleanup
```
void cleanup()
```
    Explicitly mark this status as able to be cleaned up, even though it might not be complete.
  - clone
```
MonitoredTask clone()
```
    Public exposure of Object.clone() in order to allow clients to easily capture current state.
    
    Returns:
    
    a copy of the object whose references will not change
  - toMap
```
Map<String,Object> toMap()
                  throws IOException
```
    Creates a string map of internal details for extensible exposure of monitored tasks.
    
    Returns:
    
    A Map containing information for this task.
    
    Throws:
    
    IOException
  - toJSON
```
String toJSON()
       throws IOException
```
    Creates a JSON object for parseable exposure of monitored tasks.
    
    Returns:
    
    An encoded JSON object containing information for this task.
    
    Throws:
    
    IOException

Interface MonitoredTask

Nested Class Summary

Method Summary

Method Detail

getStartTime

getDescription

getStatus

getStatusTime

getState

getStateTime

getCompletionTimestamp

getWarnTime

markComplete

pause

resume

abort

expireNow

setStatus

setDescription

setWarnTime

getStatusJournal

enableStatusJournal

disableStatusJournal

prettyPrintJournal

cleanup

clone

toMap

toJSON