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<RateAggregation.Builder>

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

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

All Implemented Interfaces:

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

Enclosing class:

RateAggregation

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

Builder for RateAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RateAggregation	build()	Builds a RateAggregation.
RateAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RateAggregation.Builder	mode(RateMode value)	API name: mode
protected RateAggregation.Builder	self()
final 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, _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 RateAggregation.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<RateAggregation.Builder,RateAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected RateAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<RateAggregation.Builder>

mode

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

API name: mode

unit

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

API name: unit

build

@Nonnull
public RateAggregation build()

Builds a RateAggregation.

Specified by:

build in interface ObjectBuilder<RateAggregation>

Throws:

NullPointerException - if some of the required fields are null.