Package org.opensearch.client.opensearch._types

Class FieldSort.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.FieldSort.Builder

All Implemented Interfaces:

ObjectBuilder<FieldSort>

Enclosing class:

FieldSort

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

Builder for FieldSort.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldSort	build()	Builds a FieldSort.
final FieldSort.Builder	field(String value)	Required - The target field
final FieldSort.Builder	format(String value)	API name: format
final FieldSort.Builder	missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
final FieldSort.Builder	missing(FieldValue value)	API name: missing
final FieldSort.Builder	mode(SortMode value)	API name: mode
final FieldSort.Builder	nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)	API name: nested
final FieldSort.Builder	nested(NestedSortValue value)	API name: nested
final FieldSort.Builder	numericType(FieldSortNumericType value)	API name: numeric_type
final FieldSort.Builder	order(SortOrder value)	API name: order
final FieldSort.Builder	unmappedType(FieldType value)	API name: unmapped_type

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 FieldSort.Builder field(String value)

Required - The target field

missing

public final FieldSort.Builder missing(@Nullable
 FieldValue value)

API name: missing

missing

public final FieldSort.Builder missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: missing

mode

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

API name: mode

nested

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

API name: nested

nested

public final FieldSort.Builder nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)

API name: nested

order

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

API name: order

unmappedType

public final FieldSort.Builder unmappedType(@Nullable
 FieldType value)

API name: unmapped_type

numericType

public final FieldSort.Builder numericType(@Nullable
 FieldSortNumericType value)

API name: numeric_type

format

public final FieldSort.Builder format(@Nullable
 String value)

API name: format

build

public FieldSort build()

Builds a FieldSort.

Specified by:

build in interface ObjectBuilder<FieldSort>

Throws:

NullPointerException - if some of the required fields are null.