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

Record Class Metric

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

Sortable

public record Metric(@Valid String fieldName, @Valid String functionName, SortSpec.Direction sort)
extends Record
implements Sortable

Constructor Summary

Constructors

Constructor	Description
Metric(@Valid String fieldName, @Valid String functionName, SortSpec.Direction sort)	Creates an instance of a Metric record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Valid String	fieldName()	Returns the value of the fieldName record component.
@Valid String	functionName()	Returns the value of the functionName record component.
final int	hashCode()	Returns a hash code value for this object.
SortSpec.Direction	sort()	Returns the value of the sort record component.
String	sortColumnName()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Metric

public Metric(@Valid
 @Valid String fieldName,
 @Valid
 @Valid String functionName,
 SortSpec.Direction sort)

Creates an instance of a Metric record class.

Parameters:

fieldName - the value for the fieldName record component

functionName - the value for the functionName record component

sort - the value for the sort record component

Method Details

sortColumnName

public String sortColumnName()

Specified by:

sortColumnName in interface Sortable

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fieldName

@Valid
public @Valid String fieldName()

Returns the value of the fieldName record component.

Returns:

the value of the fieldName record component

functionName

@Valid
public @Valid String functionName()

Returns the value of the functionName record component.

Returns:

the value of the functionName record component

sort

public SortSpec.Direction sort()

Returns the value of the sort record component.

Specified by:

sort in interface Sortable

Returns:

the value of the sort record component