FieldMetric (java-client 8.2.1 API)

java.lang.Object

co.elastic.clients.elasticsearch.rollup.FieldMetric

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class FieldMetric
extends java.lang.Object
implements JsonpSerializable

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class FieldMetric.Builder
Builder for FieldMetric.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<FieldMetric> _DESERIALIZER
Json deserializer for FieldMetric

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`field()`	Required - The field to collect metrics for.
`java.util.List<Metric>`	`metrics()`	Required - An array of metrics to collect for the field.
`static FieldMetric`	`of(java.util.function.Function<FieldMetric.Builder,ObjectBuilder<FieldMetric>> fn)`
`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`	`setupFieldMetricDeserializer(ObjectDeserializer<FieldMetric.Builder> op)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<FieldMetric> _DESERIALIZER
  
  Json deserializer for FieldMetric
Method Details
- of
  
  public static FieldMetric of(java.util.function.Function<FieldMetric.Builder,ObjectBuilder<FieldMetric>> fn)
- field
  
  public final java.lang.String field()
  
  Required - The field to collect metrics for. This must be a numeric of some kind.
  API name: field
- metrics
  
  public final java.util.List<Metric> metrics()
  
  Required - An array of metrics to collect for the field. At least one metric must be configured.
  API name: metrics
- 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
- setupFieldMetricDeserializer
  
  protected static void setupFieldMetricDeserializer(ObjectDeserializer<FieldMetric.Builder> op)