Package org.opensearch.client.opensearch._types

Class NestedSortValue

java.lang.Object

org.opensearch.client.opensearch._types.NestedSortValue

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<NestedSortValue.Builder,NestedSortValue>

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static NestedSortValue.Builder	builder()
boolean	equals(Object o)
final Query	filter()	The filter to apply to nested objects.
int	hashCode()
final Integer	maxChildren()	The maximum number of children to consider for sorting.
final NestedSortValue	nested()	How to sort hierarchical nested objects.
static NestedSortValue	of(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)
final String	path()	Required - The path to the nested objects.
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	setupNestedSortValueDeserializer(ObjectDeserializer<NestedSortValue.Builder> op)
NestedSortValue.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<NestedSortValue> _DESERIALIZER

Json deserializer for NestedSortValue

Method Details

of

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

filter

@Nullable
public final Query filter()

The filter to apply to nested objects.

API name: filter

maxChildren

@Nullable
public final Integer maxChildren()

The maximum number of children to consider for sorting.

API name: max_children

nested

@Nullable
public final NestedSortValue nested()

How to sort hierarchical nested objects.

API name: nested

path

@Nonnull
public final String path()

Required - The path to the nested objects.

API name: path

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 NestedSortValue.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<NestedSortValue.Builder,NestedSortValue>

Returns:

a new builder instance.

builder

@Nonnull
public static NestedSortValue.Builder builder()

setupNestedSortValueDeserializer

protected static void setupNestedSortValueDeserializer(ObjectDeserializer<NestedSortValue.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object