RegressionInferenceOptions.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch._types.aggregations.RegressionInferenceOptions.Builder

All Implemented Interfaces:

ObjectBuilder<RegressionInferenceOptions>

Enclosing class:

RegressionInferenceOptions
```
public static class RegressionInferenceOptions.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RegressionInferenceOptions>
```
Builder for RegressionInferenceOptions.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RegressionInferenceOptions`	`build()`	Builds a `RegressionInferenceOptions`.
`RegressionInferenceOptions.Builder`	`numTopFeatureImportanceValues(java.lang.Integer value)`	Specifies the maximum number of feature importance values per document.
`RegressionInferenceOptions.Builder`	`resultsField(java.lang.String value)`	The field that is added to incoming documents to contain the inference prediction.

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
  - resultsField
```
public final RegressionInferenceOptions.Builder resultsField(@Nullable
                                                             java.lang.String value)
```
    The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
    API name: results_field
  - numTopFeatureImportanceValues
```
public final RegressionInferenceOptions.Builder numTopFeatureImportanceValues(@Nullable
                                                                              java.lang.Integer value)
```
    Specifies the maximum number of feature importance values per document. By default, it is zero and no feature importance calculation occurs.
    API name: num_top_feature_importance_values
  - build
```
public RegressionInferenceOptions build()
```
    Builds a RegressionInferenceOptions.
    
    Specified by:
    
    build in interface ObjectBuilder<RegressionInferenceOptions>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.