Class GeoLineAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.GeoLineAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class GeoLineAggregation
extends Object
implements AggregationVariant, JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GeoLineAggregation>
Json deserializer forGeoLineAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final Boolean
Whentrue
, returns an additional array of the sort values in the feature properties.static GeoLineAggregation
final GeoLinePoint
point()
Required - The name of the geo_point field.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 Integer
size()
The maximum length of the line represented in the aggregation.final GeoLineSort
sort()
Required - The name of the numeric field to use as the sort key for ordering the points.final SortOrder
The order in which the line is sorted (ascending or descending).toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forGeoLineAggregation
-
-
Method Details
-
of
public static GeoLineAggregation of(Function<GeoLineAggregation.Builder, ObjectBuilder<GeoLineAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
point
Required - The name of the geo_point field.API name:
point
-
sort
Required - The name of the numeric field to use as the sort key for ordering the points. When thegeo_line
aggregation is nested inside atime_series
aggregation, this field defaults to@timestamp
, and any other value will result in error.API name:
sort
-
includeSort
Whentrue
, returns an additional array of the sort values in the feature properties.API name:
include_sort
-
sortOrder
The order in which the line is sorted (ascending or descending).API name:
sort_order
-
size
The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000.API name:
size
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupGeoLineAggregationDeserializer
protected static void setupGeoLineAggregationDeserializer(ObjectDeserializer<GeoLineAggregation.Builder> op)
-