Package org.opensearch.client.opensearch._types

Class ScriptSort

java.lang.Object

org.opensearch.client.opensearch._types.ScriptSort

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, SortOptionsVariant, ToCopyableBuilder<ScriptSort.Builder,ScriptSort>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ScriptSort
extends Object
implements SortOptionsVariant, PlainJsonSerializable, ToCopyableBuilder<ScriptSort.Builder,ScriptSort>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
SortOptions.Kind	_sortOptionsKind()	SortOptions variant kind.
static ScriptSort.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final SortMode	mode()	The mode for sorting on array or multi-valued fields.
final NestedSortValue	nested()	The nested path and filter for nested sorting.
static ScriptSort	of(Function<ScriptSort.Builder,ObjectBuilder<ScriptSort>> fn)
final SortOrder	order()	API name: order
final Script	script()	Required - The script to use for sorting.
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	setupScriptSortDeserializer(ObjectDeserializer<ScriptSort.Builder> op)
ScriptSort.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final ScriptSortType	type()	The type of the script sort value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ScriptSort> _DESERIALIZER

Json deserializer for ScriptSort

Method Details

of

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

_sortOptionsKind

public SortOptions.Kind _sortOptionsKind()

SortOptions variant kind.

Specified by:

_sortOptionsKind in interface SortOptionsVariant

mode

@Nullable
public final SortMode mode()

The mode for sorting on array or multi-valued fields.

API name: mode

nested

@Nullable
public final NestedSortValue nested()

The nested path and filter for nested sorting.

API name: nested

order

@Nullable
public final SortOrder order()

API name: order

script

@Nonnull
public final Script script()

Required - The script to use for sorting.

API name: script

type

@Nullable
public final ScriptSortType type()

The type of the script sort value.

API name: type

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)

toBuilder

@Nonnull
public ScriptSort.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScriptSort.Builder,ScriptSort>

Returns:

a new builder instance.

builder

@Nonnull
public static ScriptSort.Builder builder()

setupScriptSortDeserializer

protected static void setupScriptSortDeserializer(ObjectDeserializer<ScriptSort.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object