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

Record Class ResponseSchemaEntry

java.lang.Object
java.lang.Record
org.graylog.plugins.views.search.rest.scriptingapi.response.ResponseSchemaEntry
public record ResponseSchemaEntry(ResponseEntryType type, ResponseEntryDataType dataType, String functionName, String fieldName) extends Record

  • Constructor Details

    • ResponseSchemaEntry

      public ResponseSchemaEntry(ResponseEntryType type, ResponseEntryDataType dataType, String functionName, String fieldName)
      Creates an instance of a ResponseSchemaEntry record class.
      Parameters:
      type - the value for the type record component
      dataType - the value for the dataType record component
      functionName - the value for the functionName record component
      fieldName - the value for the fieldName record component

  • Method Details

    • groupBy

      public static ResponseSchemaEntry groupBy(String fieldName)

    • metric

      public static ResponseSchemaEntry metric(String functionName, String fieldName)

    • field

      public static ResponseSchemaEntry field(String fieldName, ResponseEntryDataType dataType)

    • name

      public String name()
      Returns:
      Human readable label like: grouping: http_method metric: count(action) metric: avg(took_ms)

    • 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.

    • type

      public ResponseEntryType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • dataType

      public ResponseEntryDataType dataType()
      Returns the value of the dataType record component.
      Returns:
      the value of the dataType record component

    • functionName

      public String functionName()
      Returns the value of the functionName record component.
      Returns:
      the value of the functionName record component

    • fieldName

      public String fieldName()
      Returns the value of the fieldName record component.
      Returns:
      the value of the fieldName record component