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

Class TotalHits.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

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

Enclosing class:

TotalHits

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

Builder for TotalHits.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TotalHits	build()	Builds a TotalHits.
TotalHits.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TotalHits.Builder	relation(TotalHitsRelation value)	Required - API name: relation
final TotalHits.Builder	value(long value)	Required - API name: value

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

Returns:

a new builder instance.

relation

@Nonnull
public final TotalHits.Builder relation(TotalHitsRelation value)

Required - API name: relation

value

@Nonnull
public final TotalHits.Builder value(long value)

Required - API name: value

build

@Nonnull
public TotalHits build()

Builds a TotalHits.

Specified by:

build in interface ObjectBuilder<TotalHits>

Throws:

NullPointerException - if some of the required fields are null.