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

Class DiversifiedSamplerAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.DiversifiedSamplerAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

DiversifiedSamplerAggregation

public static class DiversifiedSamplerAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
implements CopyableBuilder<DiversifiedSamplerAggregation.Builder,DiversifiedSamplerAggregation>

Builder for DiversifiedSamplerAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DiversifiedSamplerAggregation	build()	Builds a DiversifiedSamplerAggregation.
DiversifiedSamplerAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DiversifiedSamplerAggregation.Builder	executionHint(SamplerAggregationExecutionHint value)	API name: execution_hint
final DiversifiedSamplerAggregation.Builder	field(String value)	API name: field
final DiversifiedSamplerAggregation.Builder	maxDocsPerValue(Integer value)	Limits how many documents are permitted per choice of de-duplicating value.
final DiversifiedSamplerAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final DiversifiedSamplerAggregation.Builder	script(Script value)	API name: script
protected DiversifiedSamplerAggregation.Builder	self()
final DiversifiedSamplerAggregation.Builder	shardSize(Integer value)	Limits how many top-scoring documents are collected in the sample processed on each shard.

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

meta, meta, name

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

Returns:

a new builder instance.

self

@Nonnull
protected DiversifiedSamplerAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>

executionHint

@Nonnull
public final DiversifiedSamplerAggregation.Builder executionHint(@Nullable
 SamplerAggregationExecutionHint value)

API name: execution_hint

field

@Nonnull
public final DiversifiedSamplerAggregation.Builder field(@Nullable
 String value)

API name: field

maxDocsPerValue

@Nonnull
public final DiversifiedSamplerAggregation.Builder maxDocsPerValue(@Nullable
 Integer value)

Limits how many documents are permitted per choice of de-duplicating value.

API name: max_docs_per_value

script

@Nonnull
public final DiversifiedSamplerAggregation.Builder script(@Nullable
 Script value)

API name: script

script

@Nonnull
public final DiversifiedSamplerAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

shardSize

@Nonnull
public final DiversifiedSamplerAggregation.Builder shardSize(@Nullable
 Integer value)

Limits how many top-scoring documents are collected in the sample processed on each shard.

API name: shard_size

build

@Nonnull
public DiversifiedSamplerAggregation build()

Builds a DiversifiedSamplerAggregation.

Specified by:

build in interface ObjectBuilder<DiversifiedSamplerAggregation>

Throws:

NullPointerException - if some of the required fields are null.