Package org.opensearch.client.opensearch._types

Class DocStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.DocStats.Builder

All Implemented Interfaces:

CopyableBuilder<DocStats.Builder,DocStats>, MutableBuilder<DocStats.Builder,DocStats>, ObjectBuilder<DocStats>

Enclosing class:

DocStats

public static class DocStats.Builder
extends ObjectBuilderBase
implements CopyableBuilder<DocStats.Builder,DocStats>

Builder for DocStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DocStats	build()	Builds a DocStats.
DocStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DocStats.Builder	count(long value)	Required - The total number of non-deleted documents across all primary shards assigned to the selected nodes.
final DocStats.Builder	deleted(Long value)	The total number of deleted documents across all primary shards assigned to the selected nodes.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DocStats.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DocStats.Builder,DocStats>

Returns:

a new builder instance.

count

@Nonnull
public final DocStats.Builder count(long value)

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

@Nonnull
public final DocStats.Builder deleted(@Nullable
 Long value)

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

build

@Nonnull
public DocStats build()

Builds a DocStats.

Specified by:

build in interface ObjectBuilder<DocStats>

Throws:

NullPointerException - if some of the required fields are null.