com.thingworx.metrics.builder

Interface IBasicMetricBuilder<T>

Type Parameters:

T - the metric value type

All Superinterfaces:

IMetricBuilder<T>

@ThingworxExtensionApiClass(since={8,1,1})
public interface IBasicMetricBuilder<T>
extends IMetricBuilder<T>

Provides access to a metric of the provided type.

Method Summary

Modifier and Type	Method and Description
IGauge<T>	gauge(java.lang.String key) Returns a gauge metric for the appropriate type.
IGauge<java.util.List<T>>	list(java.lang.String key) Returns a list metric for the appropriate type.
IMetricSet<T>	set(java.lang.String key) Returns a set metric for the appropriate type.

Method Detail

gauge

@ThingworxExtensionApiMethod(since={8,1,1})
IGauge<T> gauge(java.lang.String key)

Returns a gauge metric for the appropriate type.

Parameters:

key - the metric key

Returns:

the resulting metric

list

@ThingworxExtensionApiMethod(since={8,1,1})
IGauge<java.util.List<T>> list(java.lang.String key)

Returns a list metric for the appropriate type.

Parameters:

key - the metric key

Returns:

the resulting metric

set

@ThingworxExtensionApiMethod(since={8,1,1})
IMetricSet<T> set(java.lang.String key)

Returns a set metric for the appropriate type.

Parameters:

key - the metric key

Returns:

the resulting metric