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

Class InferenceAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

org.opensearch.client.opensearch._types.aggregations.InferenceAggregation

All Implemented Interfaces:

JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class InferenceAggregation
extends PipelineAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceAggregation.Builder	Builder for InferenceAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

PipelineAggregationBase.AbstractBuilder<BuilderT extends PipelineAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<InferenceAggregation>	_DESERIALIZER	Json deserializer for InferenceAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
InferenceConfig	inferenceConfig()	API name: inference_config
java.lang.String	modelId()	Required - API name: model_id
static InferenceAggregation	of(java.util.function.Function<InferenceAggregation.Builder,ObjectBuilder<InferenceAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferenceAggregationDeserializer(ObjectDeserializer<InferenceAggregation.Builder> op)

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

bucketsPath, format, gapPolicy, setupPipelineAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

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.opensearch._types.aggregations.AggregationVariant

_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<InferenceAggregation> _DESERIALIZER

Json deserializer for InferenceAggregation

Method Detail

of

public static InferenceAggregation of(java.util.function.Function<InferenceAggregation.Builder,ObjectBuilder<InferenceAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

modelId

public final java.lang.String modelId()

Required - API name: model_id

inferenceConfig

@Nullable
public final InferenceConfig inferenceConfig()

API name: inference_config

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class PipelineAggregationBase

setupInferenceAggregationDeserializer

protected static void setupInferenceAggregationDeserializer(ObjectDeserializer<InferenceAggregation.Builder> op)