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

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoLineAggregation	build()	Builds a GeoLineAggregation.
final GeoLineAggregation.Builder	includeSort(Boolean value)	When true, returns an additional array of the sort values in the feature properties.
final GeoLineAggregation.Builder	point(GeoLinePoint value)	Required - The name of the geo_point field.
final GeoLineAggregation.Builder	point(Function<GeoLinePoint.Builder,ObjectBuilder<GeoLinePoint>> fn)	Required - The name of the geo_point field.
protected GeoLineAggregation.Builder	self()
final GeoLineAggregation.Builder	size(Integer value)	The maximum length of the line represented in the aggregation.
final GeoLineAggregation.Builder	sort(GeoLineSort value)	Required - The name of the numeric field to use as the sort key for ordering the points.
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.
final GeoLineAggregation.Builder	sortOrder(SortOrder value)	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

point

public final GeoLineAggregation.Builder point(GeoLinePoint value)

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

public final GeoLineAggregation.Builder sort(GeoLineSort value)

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

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 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

public final GeoLineAggregation.Builder includeSort(@Nullable
 Boolean value)

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

API name: include_sort

sortOrder

public final GeoLineAggregation.Builder sortOrder(@Nullable
 SortOrder value)

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

API name: sort_order

size

public final GeoLineAggregation.Builder size(@Nullable
 Integer value)

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

API name: size

self

protected GeoLineAggregation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GeoLineAggregation.Builder>

build

public GeoLineAggregation build()

Builds a GeoLineAggregation.

Specified by:

build in interface ObjectBuilder<GeoLineAggregation>

Throws:

NullPointerException - if some of the required fields are null.