Package org.opensearch.client.opensearch._types

Class DocStats

java.lang.Object

org.opensearch.client.opensearch._types.DocStats

All Implemented Interfaces:

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

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

The document-level statistics.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DocStats.Builder	builder()
final long	count()	Required - The total number of non-deleted documents across all primary shards assigned to the selected nodes.
final Long	deleted()	The total number of deleted documents across all primary shards assigned to the selected nodes.
boolean	equals(Object o)
int	hashCode()
static DocStats	of(Function<DocStats.Builder,ObjectBuilder<DocStats>> fn)
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	setupDocStatsDeserializer(ObjectDeserializer<DocStats.Builder> op)
DocStats.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<DocStats> _DESERIALIZER

Json deserializer for DocStats

Method Details

of

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

count

public final long count()

Required - The total number of non-deleted documents across all primary shards assigned to the selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.

API name: count

deleted

@Nullable
public final Long deleted()

The total number of deleted documents across all primary shards assigned to the selected nodes. This number is based on the number of documents stored in Lucene segments. OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged.

API name: deleted

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

Returns:

a new builder instance.

builder

@Nonnull
public static DocStats.Builder builder()

setupDocStatsDeserializer

protected static void setupDocStatsDeserializer(ObjectDeserializer<DocStats.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object