Package org.graylog.plugins.views.search.rest.scriptingapi.request

Class Metric

java.lang.Object

org.graylog.plugins.views.search.rest.scriptingapi.request.Metric

All Implemented Interfaces:

Sortable

public class Metric
extends Object
implements Sortable

Constructor Summary

Constructors

Constructor	Description
Metric(String functionName, String fieldName)
Metric(String functionName, String fieldName, SortSpec.Direction sort, MetricConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
MetricConfiguration	configuration()
boolean	equals(Object obj)
String	fieldName()
static Optional<Metric>	fromStringRepresentation(String metricString)	Creates a new Metric from its string representation
String	functionName()
int	hashCode()
SortSpec.Direction	sort()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Metric

public Metric(String functionName,
 String fieldName,
 SortSpec.Direction sort,
 MetricConfiguration configuration)

Metric

public Metric(String functionName,
 String fieldName)

Method Details

fromStringRepresentation

public static Optional<Metric> fromStringRepresentation(String metricString)

Creates a new Metric from its string representation

Parameters:

metricString - String representation in the form of "function:field", i.e. "avg:took_ms" or "latest:source" (you can ommit field for count function : "count" or "count:")

Returns:

new Metric, or null if metricString input string is blank

fieldName

public String fieldName()

functionName

public String functionName()

sort

public SortSpec.Direction sort()

Specified by:

sort in interface Sortable

configuration

public MetricConfiguration configuration()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object