Package org.opensearch.client.opensearch.core.search

Class TotalHits

java.lang.Object

org.opensearch.client.opensearch.core.search.TotalHits

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static TotalHits.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static TotalHits	of(Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)
final TotalHitsRelation	relation()	Required - API name: relation
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	setupTotalHitsDeserializer(ObjectDeserializer<TotalHits.Builder> op)
TotalHits.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final long	value()	Required - API name: 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.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TotalHits> _DESERIALIZER

Json deserializer for TotalHits

Method Details

of

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

relation

@Nonnull
public final TotalHitsRelation relation()

Required - API name: relation

value

public final long value()

Required - API name: value

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

Returns:

a new builder instance.

builder

@Nonnull
public static TotalHits.Builder builder()

setupTotalHitsDeserializer

protected static void setupTotalHitsDeserializer(ObjectDeserializer<TotalHits.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object