SingleMetricAggregateBase.AbstractBuilder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<BuilderT>
  - - org.opensearch.client.opensearch._types.aggregations.SingleMetricAggregateBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

AvgAggregate.Builder, BucketMetricValueAggregate.Builder, DerivativeAggregate.Builder, MaxAggregate.Builder, MedianAbsoluteDeviationAggregate.Builder, MinAggregate.Builder, SimpleValueAggregate.Builder, SumAggregate.Builder, ValueCountAggregate.Builder, WeightedAvgAggregate.Builder

Enclosing class:

SingleMetricAggregateBase
```
protected abstract static class SingleMetricAggregateBase.AbstractBuilder<BuilderT extends SingleMetricAggregateBase.AbstractBuilder<BuilderT>>
extends AggregateBase.AbstractBuilder<BuilderT>
```

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractBuilder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BuilderT`	`value(double value)`	Required - The metric value.
`BuilderT`	`valueAsString(java.lang.String value)`	API name: `value_as_string`

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder
meta, meta, self

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
  - AbstractBuilder
```
protected AbstractBuilder()
```
- Method Detail
  - value
```
public final BuilderT value(double value)
```
    Required - The metric value. A missing value generally means that there was no data to aggregate, unless specified otherwise.
    API name: value
    Defaults to 0 if parsed from a JSON null value.
  - valueAsString
```
public final BuilderT valueAsString(@Nullable
                                    java.lang.String value)
```
    API name: value_as_string