Package org.opensearch.client.opensearch._types.aggregations

Class TopHitsAggregate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.TopHitsAggregate.Builder

All Implemented Interfaces:

ObjectBuilder<TopHitsAggregate>

Enclosing class:

TopHitsAggregate

public static class TopHitsAggregate.Builder
extends AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>
implements ObjectBuilder<TopHitsAggregate>

Builder for TopHitsAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopHitsAggregate	build()	Builds a TopHitsAggregate.
TopHitsAggregate.Builder	hits(java.util.function.Function<HitsMetadata.Builder<JsonData>,ObjectBuilder<HitsMetadata<JsonData>>> fn)	Required - API name: hits
TopHitsAggregate.Builder	hits(HitsMetadata<JsonData> value)	Required - API name: hits
protected TopHitsAggregate.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder

meta, meta

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

hits

public final TopHitsAggregate.Builder hits(HitsMetadata<JsonData> value)

Required - API name: hits

hits

public final TopHitsAggregate.Builder hits(java.util.function.Function<HitsMetadata.Builder<JsonData>,ObjectBuilder<HitsMetadata<JsonData>>> fn)

Required - API name: hits

self

protected TopHitsAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>

build

public TopHitsAggregate build()

Builds a TopHitsAggregate.

Specified by:

build in interface ObjectBuilder<TopHitsAggregate>

Throws:

java.lang.NullPointerException - if some of the required fields are null.