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

Class Collector.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Collector.Builder

All Implemented Interfaces:

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

Enclosing class:

Collector

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

Builder for Collector.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Collector	build()	Builds a Collector.
final Collector.Builder	children(Function<Collector.Builder,ObjectBuilder<Collector>> fn)	API name: children
final Collector.Builder	children(List<Collector> list)	API name: children
final Collector.Builder	children(Collector value, Collector... values)	API name: children
Collector.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Collector.Builder	name(String value)	Required - API name: name
final Collector.Builder	reason(String value)	Required - API name: reason
final Collector.Builder	timeInNanos(long value)	Required - API name: time_in_nanos

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

Returns:

a new builder instance.

children

@Nonnull
public final Collector.Builder children(List<Collector> list)

API name: children

Adds all elements of list to children.

children

@Nonnull
public final Collector.Builder children(Collector value,
 Collector... values)

API name: children

Adds one or more values to children.

children

@Nonnull
public final Collector.Builder children(Function<Collector.Builder,ObjectBuilder<Collector>> fn)

API name: children

Adds a value to children using a builder lambda.

name

@Nonnull
public final Collector.Builder name(String value)

Required - API name: name

reason

@Nonnull
public final Collector.Builder reason(String value)

Required - API name: reason

timeInNanos

@Nonnull
public final Collector.Builder timeInNanos(long value)

Required - API name: time_in_nanos

build

@Nonnull
public Collector build()

Builds a Collector.

Specified by:

build in interface ObjectBuilder<Collector>

Throws:

NullPointerException - if some of the required fields are null.