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.
FieldSort.Builder	field(java.lang.String value)	Required - The target field
FieldSort.Builder	format(java.lang.String value)	API name: format
FieldSort.Builder	missing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
FieldSort.Builder	missing(FieldValue value)	API name: missing
FieldSort.Builder	mode(SortMode value)	API name: mode
FieldSort.Builder	nested(java.util.function.Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)	API name: nested
FieldSort.Builder	nested(NestedSortValue value)	API name: nested
FieldSort.Builder	numericType(FieldSortNumericType value)	API name: numeric_type
FieldSort.Builder	order(SortOrder value)	API name: order
FieldSort.Builder	unmappedType(FieldType value)	API name: unmapped_type

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

field

public final FieldSort.Builder field(java.lang.String value)

Required - The target field

missing

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

API name: missing

missing

public final FieldSort.Builder missing(java.util.function.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(java.util.function.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
                                      java.lang.String value)

API name: format

build

public FieldSort build()

Builds a FieldSort.

Specified by:

build in interface ObjectBuilder<FieldSort>

Throws:

java.lang.NullPointerException - if some of the required fields are null.