Class GeoLineAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<GeoLineAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.GeoLineAggregation.Builder
- All Implemented Interfaces:
WithJson<GeoLineAggregation.Builder>
,ObjectBuilder<GeoLineAggregation>
- Enclosing class:
- GeoLineAggregation
public static class GeoLineAggregation.Builder
extends WithJsonObjectBuilderBase<GeoLineAggregation.Builder>
implements ObjectBuilder<GeoLineAggregation>
Builder for
GeoLineAggregation
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGeoLineAggregation
.includeSort
(Boolean value) Whentrue
, returns an additional array of the sort values in the feature properties.point
(GeoLinePoint value) Required - The name of the geo_point field.Required - The name of the geo_point field.protected GeoLineAggregation.Builder
self()
The maximum length of the line represented in the aggregation.sort
(GeoLineSort value) Required - The name of the numeric field to use as the sort key for ordering the points.Required - The name of the numeric field to use as the sort key for ordering the points.The order in which the line is sorted (ascending or descending).Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
point
Required - The name of the geo_point field.API name:
point
-
point
public final GeoLineAggregation.Builder point(Function<GeoLinePoint.Builder, ObjectBuilder<GeoLinePoint>> fn) 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
-
sort
public final GeoLineAggregation.Builder sort(Function<GeoLineSort.Builder, ObjectBuilder<GeoLineSort>> fn) 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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<GeoLineAggregation.Builder>
-
build
Builds aGeoLineAggregation
.- Specified by:
build
in interfaceObjectBuilder<GeoLineAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-