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

Class FieldCollapse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.FieldCollapse.Builder

All Implemented Interfaces:

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

Enclosing class:

FieldCollapse

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

Builder for FieldCollapse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldCollapse	build()	Builds a FieldCollapse.
FieldCollapse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FieldCollapse.Builder	field(String value)	Required - API name: field
final FieldCollapse.Builder	innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)	The number of inner hits and their sort order.
final FieldCollapse.Builder	innerHits(List<InnerHits> list)	The number of inner hits and their sort order.
final FieldCollapse.Builder	innerHits(InnerHits value, InnerHits... values)	The number of inner hits and their sort order.
final FieldCollapse.Builder	maxConcurrentGroupSearches(Integer value)	The number of concurrent requests that are allowed to be retrieved by the inner_hits parameter per group.

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

Returns:

a new builder instance.

field

@Nonnull
public final FieldCollapse.Builder field(String value)

Required - API name: field

innerHits

@Nonnull
public final FieldCollapse.Builder innerHits(List<InnerHits> list)

The number of inner hits and their sort order.

API name: inner_hits

Adds all elements of list to innerHits.

innerHits

@Nonnull
public final FieldCollapse.Builder innerHits(InnerHits value,
 InnerHits... values)

The number of inner hits and their sort order.

API name: inner_hits

Adds one or more values to innerHits.

innerHits

@Nonnull
public final FieldCollapse.Builder innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)

The number of inner hits and their sort order.

API name: inner_hits

Adds a value to innerHits using a builder lambda.

maxConcurrentGroupSearches

@Nonnull
public final FieldCollapse.Builder maxConcurrentGroupSearches(@Nullable
 Integer value)

The number of concurrent requests that are allowed to be retrieved by the inner_hits parameter per group.

API name: max_concurrent_group_searches

build

@Nonnull
public FieldCollapse build()

Builds a FieldCollapse.

Specified by:

build in interface ObjectBuilder<FieldCollapse>

Throws:

NullPointerException - if some of the required fields are null.