Package co.elastic.clients.elasticsearch.core.field_caps

Class FieldCapability

java.lang.Object
co.elastic.clients.elasticsearch.core.field_caps.FieldCapability
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class FieldCapability
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  FieldCapability.Builder
    Builder for FieldCapability.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonpDeserializer<FieldCapability> _DESERIALIZER
    Json deserializer for FieldCapability

  • Method Summary

    Modifier and Type Method Description
    boolean aggregatable()
    Required - Whether this field can be aggregated on all indices.
    java.util.List<java.lang.String> indices()
    The list of indices where this field has the same type family, or null if all indices have the same type family for the field.
    java.util.Map<java.lang.String,​JsonData> meta()
    Merged metadata across all indices as a map of string keys to arrays of values.
    java.lang.Boolean metadataField()
    Whether this field is registered as a metadata field.
    java.util.List<java.lang.String> metricConflictsIndices()
    The list of indices where this field is present if these indices don’t have the same time_series_metric value for this field.
    java.util.List<java.lang.String> nonAggregatableIndices()
    The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.
    java.util.List<java.lang.String> nonDimensionIndices()
    If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.
    java.util.List<java.lang.String> nonSearchableIndices()
    The list of indices where this field is not searchable, or null if all indices have the same definition for the field.
    static FieldCapability of​(java.util.function.Function<FieldCapability.Builder,​ObjectBuilder<FieldCapability>> fn)  
    boolean searchable()
    Required - Whether this field is indexed for search on all indices.
    void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
    Serialize this object to JSON.
    protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)  
    protected static void setupFieldCapabilityDeserializer​(ObjectDeserializer<FieldCapability.Builder> op)  
    java.lang.Boolean timeSeriesDimension()
    Whether this field is used as a time series dimension.
    TimeSeriesMetricType timeSeriesMetric()
    Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric.
    java.lang.String toString()  
    java.lang.String type()
    Required - API name: type

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Method Details

    • of

      public static FieldCapability of​(java.util.function.Function<FieldCapability.Builder,​ObjectBuilder<FieldCapability>> fn)

    • aggregatable

      public final boolean aggregatable()
      Required - Whether this field can be aggregated on all indices.

      API name: aggregatable

    • indices

      public final java.util.List<java.lang.String> indices()
      The list of indices where this field has the same type family, or null if all indices have the same type family for the field.

      API name: indices

    • meta

      public final java.util.Map<java.lang.String,​JsonData> meta()
      Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.

      API name: meta

    • nonAggregatableIndices

      public final java.util.List<java.lang.String> nonAggregatableIndices()
      The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.

      API name: non_aggregatable_indices

    • nonSearchableIndices

      public final java.util.List<java.lang.String> nonSearchableIndices()
      The list of indices where this field is not searchable, or null if all indices have the same definition for the field.

      API name: non_searchable_indices

    • searchable

      public final boolean searchable()
      Required - Whether this field is indexed for search on all indices.

      API name: searchable

    • type

      public final java.lang.String type()
      Required - API name: type

    • metadataField

      @Nullable public final java.lang.Boolean metadataField()
      Whether this field is registered as a metadata field.

      API name: metadata_field

    • timeSeriesDimension

      @Nullable public final java.lang.Boolean timeSeriesDimension()
      Whether this field is used as a time series dimension.

      API name: time_series_dimension

    • timeSeriesMetric

      @Nullable public final TimeSeriesMetricType timeSeriesMetric()
      Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric.

      API name: time_series_metric

    • nonDimensionIndices

      public final java.util.List<java.lang.String> nonDimensionIndices()
      If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.

      API name: non_dimension_indices

    • metricConflictsIndices

      public final java.util.List<java.lang.String> metricConflictsIndices()
      The list of indices where this field is present if these indices don’t have the same time_series_metric value for this field.

      API name: metric_conflicts_indices

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • setupFieldCapabilityDeserializer

      protected static void setupFieldCapabilityDeserializer​(ObjectDeserializer<FieldCapability.Builder> op)