Package org.opensearch.client.opensearch._types

Class FieldSort

java.lang.Object

org.opensearch.client.opensearch._types.FieldSort

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, SortOptionsVariant

@JsonpDeserializable
public class FieldSort
extends Object
implements SortOptionsVariant, PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldSort.Builder	Builder for FieldSort.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<FieldSort>	_DESERIALIZER	Json deserializer for FieldSort

Method Summary

Modifier and Type	Method	Description
SortOptions.Kind	_sortOptionsKind()	SortOptions variant kind.
final String	field()	Required - The target field
final String	format()	API name: format
final FieldValue	missing()	API name: missing
final SortMode	mode()	API name: mode
final NestedSortValue	nested()	API name: nested
final FieldSortNumericType	numericType()	API name: numeric_type
static FieldSort	of(Function<FieldSort.Builder,ObjectBuilder<FieldSort>> fn)
final SortOrder	order()	API name: order
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFieldSortDeserializer(ObjectDeserializer<FieldSort.Builder> op)
final FieldType	unmappedType()	API name: unmapped_type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.SortOptionsVariant

_toSortOptions

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FieldSort> _DESERIALIZER

Json deserializer for FieldSort

Method Details

of

public static FieldSort of(Function<FieldSort.Builder,ObjectBuilder<FieldSort>> fn)

_sortOptionsKind

public SortOptions.Kind _sortOptionsKind()

SortOptions variant kind.

Specified by:

_sortOptionsKind in interface SortOptionsVariant

field

public final String field()

Required - The target field

missing

@Nullable
public final FieldValue missing()

API name: missing

mode

@Nullable
public final SortMode mode()

API name: mode

nested

@Nullable
public final NestedSortValue nested()

API name: nested

order

@Nullable
public final SortOrder order()

API name: order

unmappedType

@Nullable
public final FieldType unmappedType()

API name: unmapped_type

numericType

@Nullable
public final FieldSortNumericType numericType()

API name: numeric_type

format

@Nullable
public final String format()

API name: format

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupFieldSortDeserializer

protected static void setupFieldSortDeserializer(ObjectDeserializer<FieldSort.Builder> op)