Module org.elasticsearch.server
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Constructor Summary
ConstructorsConstructorDescriptionIndexFieldCapabilities(String name, String type, boolean isMetadatafield, boolean isSearchable, boolean isAggregatable, boolean isDimension, TimeSeriesParams.MetricType metricType, Map<String, String> meta) Creates an instance of aIndexFieldCapabilitiesrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of theisAggregatablerecord component.booleanReturns the value of theisDimensionrecord component.booleanReturns the value of theisMetadatafieldrecord component.booleanReturns the value of theisSearchablerecord component.meta()Returns the value of themetarecord component.Returns the value of themetricTyperecord component.name()Returns the value of thenamerecord component.static IndexFieldCapabilitiesreadFrom(StreamInput in) final StringtoString()Returns a string representation of this record class.type()Returns the value of thetyperecord component.voidwriteTo(StreamOutput out) Write this into the StreamOutput.
-
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 aIndexFieldCapabilitiesrecord class.- Parameters:
name- the value for thenamerecord componenttype- the value for thetyperecord componentisMetadatafield- the value for theisMetadatafieldrecord componentisSearchable- the value for theisSearchablerecord componentisAggregatable- the value for theisAggregatablerecord componentisDimension- the value for theisDimensionrecord componentmetricType- the value for themetricTyperecord componentmeta- the value for themetarecord component
-
-
Method Details
-
readFrom
- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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. -
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. -
equals
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 withObjects::equals(Object,Object); primitive components are compared with '=='. -
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
type
Returns the value of thetyperecord component.- Returns:
- the value of the
typerecord component
-
isMetadatafield
public boolean isMetadatafield()Returns the value of theisMetadatafieldrecord component.- Returns:
- the value of the
isMetadatafieldrecord component
-
isSearchable
public boolean isSearchable()Returns the value of theisSearchablerecord component.- Returns:
- the value of the
isSearchablerecord component
-
isAggregatable
public boolean isAggregatable()Returns the value of theisAggregatablerecord component.- Returns:
- the value of the
isAggregatablerecord component
-
isDimension
public boolean isDimension()Returns the value of theisDimensionrecord component.- Returns:
- the value of the
isDimensionrecord component
-
metricType
Returns the value of themetricTyperecord component.- Returns:
- the value of the
metricTyperecord component
-
meta
Returns the value of themetarecord component.- Returns:
- the value of the
metarecord component
-