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

Class TrackHits

java.lang.Object

org.opensearch.client.opensearch.core.search.TrackHits

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<TrackHits.Kind,Object>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TrackHits
extends Object
implements TaggedUnion<TrackHits.Kind,Object>, PlainJsonSerializable

The number of hits matching the query. When true, the exact number of hits is returned at the cost of some performance. When false, the response does not include the total number of hits matching the query. Default is 10,000 hits.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final TrackHits.Kind	_kind()	Get the of the kind of variant held by this object.
String	_toJsonString()
static TrackHits.Builder	builder()
Integer	count()	Get the count variant value.
Boolean	enabled()	Get the enabled variant value.
boolean	equals(Object o)
int	hashCode()
boolean	isCount()	Is this variant instance of kind count?
boolean	isEnabled()	Is this variant instance of kind enabled?
static TrackHits	of(Function<TrackHits.Builder,ObjectBuilder<TrackHits>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
TrackHits.Builder	toBuilder()

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TrackHits> _DESERIALIZER

Method Details

_kind

public final TrackHits.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<TrackHits.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<TrackHits.Kind,Object>

of

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

_toJsonString

public String _toJsonString()

isCount

public boolean isCount()

Is this variant instance of kind count?

count

public Integer count()

Get the count variant value.

Throws:

IllegalStateException - if the current variant is not the count kind.

isEnabled

public boolean isEnabled()

Is this variant instance of kind enabled?

enabled

public Boolean enabled()

Get the enabled variant value.

Throws:

IllegalStateException - if the current variant is not the enabled kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public TrackHits.Builder toBuilder()

builder

@Nonnull
public static TrackHits.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object