TaskLifecycleMetrics (Granules-3.0.0-SNAPSHOT API)

All Known Implementing Classes:

TaskLifecycleMetricsReader
```
public interface TaskLifecycleMetrics
```
This is an interface that snapshots the lifecyle of a task. This interface can be used to retrieve the status of a task, its CPU bound time and the number of times that it has been scheduled for execution.

Author:

Shrideep Pallickara

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABNORMAL_TERMINATION`
`static int`	`ABORTED`
`static int`	`COMPLETE`
`static int`	`EXECUTING`
`static int`	`INITIALIZED`
`static int`	`INITIALIZING`
`static int`	`NOT_SET`
`static int`	`QUEUED_FOR_EXECUTION`
`static int`	`READY`
`static int`	`WAITING_FOR_DATA`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getArrivalTime()` Retrieve the time at which the operation arrived at this node.
`byte[]`	`getBytes()` Create the serialized representation of this class.
`long`	`getCompletionTime()` Retrieve the time at which this task was completed
`long`	`getCPUBoundTime()` Retrieve the CPU-bound time of the computation.
`int`	`getExecutionStatus()` Retrieve the execution status associated with the operation.
`String`	`getInstanceIdentifier()` Retrieve the instance identifier of the operation that was encapsulated within a Task.
`int`	`getNumberofIterationsSoFar()` Retrieve the number of iterations performed for the operation so far
`long`	`getStartTime()` Retrieve the time this operation was first launched
`String`	`getTaskCompletionInfo()` Retrieve information about the completion of a task.
`long`	`getTimeResidentInMemory()` Retrieve the time this operation spent residing in memory

- Field Detail
  - NOT_SET
```
static final int NOT_SET
```
    See Also:
    Constant Field Values
  - INITIALIZING
```
static final int INITIALIZING
```
    See Also:
    Constant Field Values
  - INITIALIZED
```
static final int INITIALIZED
```
    See Also:
    Constant Field Values
  - READY
```
static final int READY
```
    See Also:
    Constant Field Values
  - COMPLETE
```
static final int COMPLETE
```
    See Also:
    Constant Field Values
  - WAITING_FOR_DATA
```
static final int WAITING_FOR_DATA
```
    See Also:
    Constant Field Values
  - EXECUTING
```
static final int EXECUTING
```
    See Also:
    Constant Field Values
  - QUEUED_FOR_EXECUTION
```
static final int QUEUED_FOR_EXECUTION
```
    See Also:
    Constant Field Values
  - ABNORMAL_TERMINATION
```
static final int ABNORMAL_TERMINATION
```
    See Also:
    Constant Field Values
  - ABORTED
```
static final int ABORTED
```
    See Also:
    Constant Field Values
- Method Detail
  - getInstanceIdentifier
```
String getInstanceIdentifier()
```
    Retrieve the instance identifier of the operation that was encapsulated within a Task. This will allow us to determine which taskId was connected to which instanceId.
    
    Returns:
    The instance identifier of the operation.
  - getNumberofIterationsSoFar
```
int getNumberofIterationsSoFar()
```
    Retrieve the number of iterations performed for the operation so far
    
    Returns:
    The number of times that the computation has been inovoked so far.
  - getCPUBoundTime
```
long getCPUBoundTime()
```
    Retrieve the CPU-bound time of the computation.
    
    Returns:
    The CPU-bound time in milliseconds.
  - getArrivalTime
```
long getArrivalTime()
```
    Retrieve the time at which the operation arrived at this node.
    
    Returns:
    The arrival time in milliseconds.
  - getStartTime
```
long getStartTime()
```
    Retrieve the time this operation was first launched
    
    Returns:
    The startTime in milliseconds.
  - getCompletionTime
```
long getCompletionTime()
```
    Retrieve the time at which this task was completed
    
    Returns:
    The completion time in milliseconds.
  - getTimeResidentInMemory
```
long getTimeResidentInMemory()
```
    Retrieve the time this operation spent residing in memory
    
    Returns:
    The memory-resident time in milliseconds.
  - getExecutionStatus
```
int getExecutionStatus()
```
    Retrieve the execution status associated with the operation.
    
    Returns:
    The execution status for the task
  - getTaskCompletionInfo
```
String getTaskCompletionInfo()
```
    Retrieve information about the completion of a task. In the case of errors and aborts of executions this will include information about why a task was prematurely terminated.
    
    Returns:
    The task completion information as a String
  - getBytes
```
byte[] getBytes()
                throws IOException
```
    Create the serialized representation of this class.
    
    Returns:
    The byte[] stream for this object.
    
    Throws:
    
    IOException

Interface TaskLifecycleMetrics

Field Summary

Method Summary

Field Detail

NOT_SET

INITIALIZING

INITIALIZED

READY

COMPLETE

WAITING_FOR_DATA

EXECUTING

QUEUED_FOR_EXECUTION

ABNORMAL_TERMINATION

ABORTED

Method Detail

getInstanceIdentifier

getNumberofIterationsSoFar

getCPUBoundTime

getArrivalTime

getStartTime

getCompletionTime

getTimeResidentInMemory

getExecutionStatus

getTaskCompletionInfo

getBytes