Package co.elastic.clients.elasticsearch._types.aggregations

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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoLineAggregation.Builder	Builder for GeoLineAggregation.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeoLineAggregation>	_DESERIALIZER	Json deserializer for GeoLineAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final Boolean	includeSort()	When true, returns an additional array of the sort values in the feature properties.
static GeoLineAggregation	of(Function<GeoLineAggregation.Builder,ObjectBuilder<GeoLineAggregation>> fn)
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	setupGeoLineAggregationDeserializer(ObjectDeserializer<GeoLineAggregation.Builder> op)
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	sortOrder()	The order in which the line is sorted (ascending or descending).
String	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

public static final JsonpDeserializer<GeoLineAggregation> _DESERIALIZER

Json deserializer for GeoLineAggregation

Method Details

of

public static GeoLineAggregation of(Function<GeoLineAggregation.Builder,ObjectBuilder<GeoLineAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

point

public final GeoLinePoint point()

Required - The name of the geo_point field.

API name: point

sort

public final GeoLineSort sort()

Required - The name of the numeric field to use as the sort key for ordering the points. When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error.

API name: sort

includeSort

@Nullable
public final Boolean includeSort()

When true, returns an additional array of the sort values in the feature properties.

API name: include_sort

sortOrder

@Nullable
public final SortOrder sortOrder()

The order in which the line is sorted (ascending or descending).

API name: sort_order

size

@Nullable
public final Integer size()

The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000.

API name: size

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

setupGeoLineAggregationDeserializer

protected static void setupGeoLineAggregationDeserializer(ObjectDeserializer<GeoLineAggregation.Builder> op)