org.hawkular.metrics.tasks.api

Class TaskType

java.lang.Object

org.hawkular.metrics.tasks.api.TaskType

public class TaskType
extends Object

Tasks are grouped by type, and execution order is also determined by type. If there are types A, B, C, then for a given time slice all tasks of type A are executed followed by tasks of type B and finally tasks of type C are executed. The task type specifies the granularity of partitioning of tasks in the database. It also provides a factory function that produces a function to execute tasks.

Author:

jsanda

Constructor Summary

Constructors

Constructor and Description
TaskType()

Method Summary

Modifier and Type	Method and Description
Task	createTask(String tenantId, String target, String source) A factory method for creating tasks of this type.
Task	createTask(String tenantId, String target, String source, int interval, int window) A factory method for creating tasks of this type.
boolean	equals(Object o)
int	getInterval() The default frequency of execution for tasks of this type.
String	getName() The task type name which must be unique among task types.
int	getSegmentOffsets() Tasks are associated with leases.
int	getSegments() The number of partitions in the database to use for storing tasks.
int	getWindow() The default amount of data to include for tasks of this type, expressed as a duration.
int	hashCode()
TaskType	setInterval(int interval)
TaskType	setName(String name)
TaskType	setSegmentOffsets(int segmentOffsets)
TaskType	setSegments(int segments)
TaskType	setWindow(int window)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskType

public TaskType()

Method Detail

getName

public String getName()

The task type name which must be unique among task types.

setName

public TaskType setName(String name)

getSegments

public int getSegments()

The number of partitions in the database to use for storing tasks. The segment is determined by, task.target.hashCode() % segments

setSegments

public TaskType setSegments(int segments)

getSegmentOffsets

public int getSegmentOffsets()

Tasks are associated with leases. A client needs to acquire a lease before it can execute the tasks associated with the lease. This property specifies how many tasks in terms of segments are associated with a lease. Let's say that we have 100 segments and 10 segment offsets. This means that there are 10 task segments per lease. When a client acquires a lease, the client will then execute the tasks in each of those segments.

TODO Come up with a more descriptive name

setSegmentOffsets

public TaskType setSegmentOffsets(int segmentOffsets)

getInterval

public int getInterval()

The default frequency of execution for tasks of this type. The time unit is configured globally with TaskServiceBuilder.withTimeUnit(TimeUnit).

setInterval

public TaskType setInterval(int interval)

getWindow

public int getWindow()

The default amount of data to include for tasks of this type, expressed as a duration. The time unit is configured globally with TaskServiceBuilder.withTimeUnit(TimeUnit).

setWindow

public TaskType setWindow(int window)

createTask

public Task createTask(String tenantId,
                       String target,
                       String source)

A factory method for creating tasks of this type.

Parameters:

target - Identifier or key of the time series associated with the task

source - Identifier or key of the time series that provides input data for the task

Returns:

A Task

createTask

public Task createTask(String tenantId,
                       String target,
                       String source,
                       int interval,
                       int window)

A factory method for creating tasks of this type. Note that the time units for interval and window is configured globally with TaskServiceBuilder.withTimeUnit(TimeUnit).

Parameters:

target - Identifier or key of the time series associated with the task

source - Identifier or key of the time series that provides input data for the task

interval - Specifies the frequency of execution

window - Specifies the amount of data to include, expressed as a duration

Returns:

A Task

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object