Package org.opensearch.client.opensearch._types

Class GeoDistanceSort.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.GeoDistanceSort.Builder

All Implemented Interfaces:

ObjectBuilder<GeoDistanceSort>

Enclosing class:

GeoDistanceSort

public static class GeoDistanceSort.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GeoDistanceSort>

Builder for GeoDistanceSort.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceSort	build()	Builds a GeoDistanceSort.
final GeoDistanceSort.Builder	distanceType(GeoDistanceType value)	API name: distance_type
final GeoDistanceSort.Builder	field(String value)	Required -
final GeoDistanceSort.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
final GeoDistanceSort.Builder	location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	Required - Adds a value to location using a builder lambda.
final GeoDistanceSort.Builder	location(List<GeoLocation> list)	Required - Adds all elements of list to location.
final GeoDistanceSort.Builder	location(GeoLocation value, GeoLocation... values)	Required - Adds one or more values to location.
final GeoDistanceSort.Builder	mode(SortMode value)	API name: mode
final GeoDistanceSort.Builder	nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)	API name: nested
final GeoDistanceSort.Builder	nested(NestedSortValue value)	API name: nested
final GeoDistanceSort.Builder	order(SortOrder value)	API name: order
final GeoDistanceSort.Builder	unit(DistanceUnit value)	API name: unit
final GeoDistanceSort.Builder	validationMethod(GeoValidationMethod value)	API name: validation_method

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

field

public final GeoDistanceSort.Builder field(String value)

Required -

location

public final GeoDistanceSort.Builder location(List<GeoLocation> list)

Required - Adds all elements of list to location.

location

public final GeoDistanceSort.Builder location(GeoLocation value,
 GeoLocation... values)

Required - Adds one or more values to location.

location

public final GeoDistanceSort.Builder location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)

Required - Adds a value to location using a builder lambda.

mode

public final GeoDistanceSort.Builder mode(@Nullable
 SortMode value)

API name: mode

distanceType

public final GeoDistanceSort.Builder distanceType(@Nullable
 GeoDistanceType value)

API name: distance_type

ignoreUnmapped

public final GeoDistanceSort.Builder ignoreUnmapped(@Nullable
 Boolean value)

API name: ignore_unmapped

order

public final GeoDistanceSort.Builder order(@Nullable
 SortOrder value)

API name: order

unit

public final GeoDistanceSort.Builder unit(@Nullable
 DistanceUnit value)

API name: unit

validationMethod

public final GeoDistanceSort.Builder validationMethod(@Nullable
 GeoValidationMethod value)

API name: validation_method

nested

public final GeoDistanceSort.Builder nested(@Nullable
 NestedSortValue value)

API name: nested

nested

public final GeoDistanceSort.Builder nested(@Nonnull
 Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)

API name: nested

build

public GeoDistanceSort build()

Builds a GeoDistanceSort.

Specified by:

build in interface ObjectBuilder<GeoDistanceSort>

Throws:

NullPointerException - if some of the required fields are null.