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

Class RateAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder<RateAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.RateAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<RateAggregation>

Enclosing class:

RateAggregation

public static class RateAggregation.Builder
extends FormatMetricAggregationBase.AbstractBuilder<RateAggregation.Builder>
implements ObjectBuilder<RateAggregation>

Builder for RateAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RateAggregation	build()	Builds a RateAggregation.
RateAggregation.Builder	mode(RateMode value)	API name: mode
protected RateAggregation.Builder	self()
RateAggregation.Builder	unit(CalendarInterval value)	API name: unit

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

format

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

field, missing, missing, script, script

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

unit

public final RateAggregation.Builder unit(@Nullable
                                          CalendarInterval value)

API name: unit

mode

public final RateAggregation.Builder mode(@Nullable
                                          RateMode value)

API name: mode

self

protected RateAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<RateAggregation.Builder>

build

public RateAggregation build()

Builds a RateAggregation.

Specified by:

build in interface ObjectBuilder<RateAggregation>

Throws:

java.lang.NullPointerException - if some of the required fields are null.