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:

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

Enclosing class:

TopHitsAggregate

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

Builder for TopHitsAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopHitsAggregate	build()	Builds a TopHitsAggregate.
TopHitsAggregate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TopHitsAggregate.Builder	hits(Function<HitsMetadata.Builder<JsonData>,ObjectBuilder<HitsMetadata<JsonData>>> fn)	Required - API name: hits
final 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, _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 TopHitsAggregate.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<TopHitsAggregate.Builder,TopHitsAggregate>

Returns:

a new builder instance.

self

@Nonnull
protected TopHitsAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>

hits

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

Required - API name: hits

hits

@Nonnull
public final TopHitsAggregate.Builder hits(Function<HitsMetadata.Builder<JsonData>,ObjectBuilder<HitsMetadata<JsonData>>> fn)

Required - API name: hits

build

@Nonnull
public TopHitsAggregate build()

Builds a TopHitsAggregate.

Specified by:

build in interface ObjectBuilder<TopHitsAggregate>

Throws:

NullPointerException - if some of the required fields are null.