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 Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static FieldCapability of(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 List<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 Map<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 List<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 List<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 String type()
      Required - API name: type

    • metadataField

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

      API name: metadata_field

    • timeSeriesDimension

      @Nullable public final 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 List<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 List<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 String toString()
      Overrides:
      toString in class Object

    • setupFieldCapabilityDeserializer

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