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

Class BucketScriptAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.BucketPathAggregation.AbstractBuilder<BucketScriptAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase.AbstractBuilder<BucketScriptAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketScriptAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

BucketScriptAggregation

public static class BucketScriptAggregation.Builder
extends PipelineAggregationBase.AbstractBuilder<BucketScriptAggregation.Builder>
implements CopyableBuilder<BucketScriptAggregation.Builder,BucketScriptAggregation>

Builder for BucketScriptAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketScriptAggregation	build()	Builds a BucketScriptAggregation.
BucketScriptAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BucketScriptAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final BucketScriptAggregation.Builder	script(Script value)	API name: script
protected BucketScriptAggregation.Builder	self()

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

format, gapPolicy

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

bucketsPath, bucketsPath

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

Returns:

a new builder instance.

self

@Nonnull
protected BucketScriptAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<BucketScriptAggregation.Builder>

script

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

API name: script

script

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

API name: script

build

@Nonnull
public BucketScriptAggregation build()

Builds a BucketScriptAggregation.

Specified by:

build in interface ObjectBuilder<BucketScriptAggregation>

Throws:

NullPointerException - if some of the required fields are null.