Module org.elasticsearch.server
Package org.elasticsearch.action.fieldcaps

Record Class IndexFieldCapabilities

java.lang.Object
java.lang.Record
org.elasticsearch.action.fieldcaps.IndexFieldCapabilities
Record Components:
name - The name of the field.
type - The type associated with the field.
isSearchable - Whether this field is indexed for search.
isAggregatable - Whether this field can be aggregated on.
meta - Metadata about the field.
All Implemented Interfaces:
Writeable
public record IndexFieldCapabilities(String name, String type, boolean isMetadatafield, boolean isSearchable, boolean isAggregatable, boolean isDimension, TimeSeriesParams.MetricType metricType, Map<String,String> meta) extends Record implements Writeable
Describes the capabilities of a field in a single index.

  • Constructor Details

    • IndexFieldCapabilities

      public IndexFieldCapabilities(String name, String type, boolean isMetadatafield, boolean isSearchable, boolean isAggregatable, boolean isDimension, TimeSeriesParams.MetricType metricType, Map<String,String> meta)
      Creates an instance of a IndexFieldCapabilities record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      isMetadatafield - the value for the isMetadatafield record component
      isSearchable - the value for the isSearchable record component
      isAggregatable - the value for the isAggregatable record component
      isDimension - the value for the isDimension record component
      metricType - the value for the metricType record component
      meta - the value for the meta record component

  • Method Details

    • readFrom

      public static IndexFieldCapabilities readFrom(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • name

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

    • type

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

    • isMetadatafield

      public boolean isMetadatafield()
      Returns the value of the isMetadatafield record component.
      Returns:
      the value of the isMetadatafield record component

    • isSearchable

      public boolean isSearchable()
      Returns the value of the isSearchable record component.
      Returns:
      the value of the isSearchable record component

    • isAggregatable

      public boolean isAggregatable()
      Returns the value of the isAggregatable record component.
      Returns:
      the value of the isAggregatable record component

    • isDimension

      public boolean isDimension()
      Returns the value of the isDimension record component.
      Returns:
      the value of the isDimension record component

    • metricType

      public TimeSeriesParams.MetricType metricType()
      Returns the value of the metricType record component.
      Returns:
      the value of the metricType record component

    • meta

      public Map<String,String> meta()
      Returns the value of the meta record component.
      Returns:
      the value of the meta record component