org.hawkular.metrics.tasks.api

Interface Task

All Known Implementing Classes:

TaskImpl

public interface Task

Represents a unit of work to be performed by a user supplied function. All tasks are considered repeating and are rescheduled on fixed intervals.

Author:

jsanda

Method Summary

Modifier and Type	Method and Description
org.joda.time.Duration	getInterval() The frequency of the task execution, e.g., five minutes.
Set<String>	getSources() The keys or identifiers of the time series associated with the source data being operated on.
String	getTarget() This is a key or identifier of the time series that is associated with the task.
TaskType	getTaskType()
org.joda.time.DateTime	getTimeSlice() The end time of the time slice for which the task is scheduled.
org.joda.time.Duration	getWindow() Specifies the amount of data to be included.

Method Detail

getTaskType

TaskType getTaskType()

getTarget

String getTarget()

This is a key or identifier of the time series that is associated with the task. Consider aggregating metrics or events as an example. Let's say there is a task for computing a 5 minute rollup from raw data. This property should be the key or identifier of the 5 minute rollup time series.

getSources

Set<String> getSources()

The keys or identifiers of the time series associated with the source data being operated on. There can be one or more sources. Consider aggregating metrics or events as an example. There is a task for computing a 5 minute rollup from raw data. This property identifies the time series of the raw data to be aggregated.

getInterval

org.joda.time.Duration getInterval()

The frequency of the task execution, e.g., five minutes.

getWindow

org.joda.time.Duration getWindow()

Specifies the amount of data to be included. For an aggregation task that runs every 5 minutes with a window of 15 minutes, the task should query for data from the past 15 minutes using timeSlice as the end time.

getTimeSlice

org.joda.time.DateTime getTimeSlice()

The end time of the time slice for which the task is scheduled. If a task has an interval of an hour, then the time slice would be 9:00 - 10:00, 10:00 - 11:00, etc. The task is guaranteed to run no earlier than this time.