Class FieldCapability
java.lang.Object
co.elastic.clients.elasticsearch.core.field_caps.FieldCapability
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<FieldCapability>
Json deserializer forFieldCapability
-
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Required - Whether this field can be aggregated on all indices.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.meta()
Merged metadata across all indices as a map of string keys to arrays of values.final Boolean
Whether this field is registered as a metadata field.The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.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.The list of indices where this field is not searchable, or null if all indices have the same definition for the field.static FieldCapability
final boolean
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
final Boolean
Whether this field is used as a time series dimension.final TimeSeriesMetricType
Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric.toString()
final String
type()
Required - API name:type
-
Field Details
-
_DESERIALIZER
Json deserializer forFieldCapability
-
-
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
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
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
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
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
Required - API name:type
-
metadataField
Whether this field is registered as a metadata field.API name:
metadata_field
-
timeSeriesDimension
Whether this field is used as a time series dimension.API name:
time_series_dimension
-
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
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
The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.API name:
metric_conflicts_indices
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupFieldCapabilityDeserializer
protected static void setupFieldCapabilityDeserializer(ObjectDeserializer<FieldCapability.Builder> op)
-