Package org.opensearch.client.opensearch._types

Class SortOptions

java.lang.Object

org.opensearch.client.opensearch._types.SortOptions

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<SortOptions.Kind,Object>

@JsonpDeserializable
public class SortOptions
extends Object
implements TaggedUnion<SortOptions.Kind,Object>, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SortOptions.Builder
static enum	SortOptions.Kind	SortOptions variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SortOptions>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
SortOptions(SortOptionsVariant value)

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final SortOptions.Kind	_kind()	Get the of the kind of variant held by this object.
ScoreSort	doc()	Get the _doc variant value.
FieldSort	field()	Get the field variant value.
GeoDistanceSort	geoDistance()	Get the _geo_distance variant value.
boolean	isDoc()	Is this variant instance of kind _doc?
boolean	isField()	Is this variant instance of kind field?
boolean	isGeoDistance()	Is this variant instance of kind _geo_distance?
boolean	isScore()	Is this variant instance of kind _score?
boolean	isScript()	Is this variant instance of kind _script?
static SortOptions	of(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)
ScoreSort	score()	Get the _score variant value.
ScriptSort	script()	Get the _script variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SortOptions> _DESERIALIZER

Constructor Details

SortOptions

public SortOptions(SortOptionsVariant value)

Method Details

_kind

public final SortOptions.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<SortOptions.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<SortOptions.Kind,Object>

of

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

isScore

public boolean isScore()

Is this variant instance of kind _score?

score

public ScoreSort score()

Get the _score variant value.

Throws:

IllegalStateException - if the current variant is not of the _score kind.

isDoc

public boolean isDoc()

Is this variant instance of kind _doc?

doc

public ScoreSort doc()

Get the _doc variant value.

Throws:

IllegalStateException - if the current variant is not of the _doc kind.

isGeoDistance

public boolean isGeoDistance()

Is this variant instance of kind _geo_distance?

geoDistance

public GeoDistanceSort geoDistance()

Get the _geo_distance variant value.

Throws:

IllegalStateException - if the current variant is not of the _geo_distance kind.

isScript

public boolean isScript()

Is this variant instance of kind _script?

script

public ScriptSort script()

Get the _script variant value.

Throws:

IllegalStateException - if the current variant is not of the _script kind.

isField

public boolean isField()

Is this variant instance of kind field?

field

public FieldSort field()

Get the field variant value.

Throws:

IllegalStateException - if the current variant is not of the field kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable