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

Class MatrixStatsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.MatrixAggregation.AbstractBuilder<MatrixStatsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.MatrixStatsAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

MatrixStatsAggregation

public static class MatrixStatsAggregation.Builder
extends MatrixAggregation.AbstractBuilder<MatrixStatsAggregation.Builder>
implements CopyableBuilder<MatrixStatsAggregation.Builder,MatrixStatsAggregation>

Builder for MatrixStatsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MatrixStatsAggregation	build()	Builds a MatrixStatsAggregation.
MatrixStatsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MatrixStatsAggregation.Builder	mode(SortMode value)	API name: mode
protected MatrixStatsAggregation.Builder	self()

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

fields, fields, missing, missing

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

Returns:

a new builder instance.

self

@Nonnull
protected MatrixStatsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<MatrixStatsAggregation.Builder>

mode

@Nonnull
public final MatrixStatsAggregation.Builder mode(@Nullable
 SortMode value)

API name: mode

build

@Nonnull
public MatrixStatsAggregation build()

Builds a MatrixStatsAggregation.

Specified by:

build in interface ObjectBuilder<MatrixStatsAggregation>

Throws:

NullPointerException - if some of the required fields are null.