Package org.elasticsearch.client.analytics

Class InferencePipelineAggregationBuilder

java.lang.Object
org.elasticsearch.search.aggregations.PipelineAggregationBuilder
org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>
org.elasticsearch.client.analytics.InferencePipelineAggregationBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.PipelineAggregationBuilder>, org.elasticsearch.search.aggregations.BaseAggregationBuilder
public class InferencePipelineAggregationBuilder
extends org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>
For building inference pipeline aggregations NOTE: This extends AbstractPipelineAggregationBuilder for compatibility with SearchSourceBuilder.aggregation(PipelineAggregationBuilder) but it doesn't support any "server" side things like doWriteTo(StreamOutput) or createInternal(Map)

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

    org.elasticsearch.search.aggregations.PipelineAggregationBuilder.ValidationContext

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField MODEL_ID  
    static java.lang.String NAME  

    Fields inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

    BUCKETS_PATH_FIELD, metadata, type

    Fields inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

    bucketsPaths, name

    Fields inherited from interface org.elasticsearch.index.query.Rewriteable

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    InferencePipelineAggregationBuilder​(java.lang.String name, java.lang.String modelId, java.util.Map<java.lang.String,​java.lang.String> bucketsPath)  

  • Method Summary

    Modifier and Type Method Description
    protected org.elasticsearch.search.aggregations.pipeline.PipelineAggregator createInternal​(java.util.Map<java.lang.String,​java.lang.Object> metaData)  
    protected void doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)  
    boolean equals​(java.lang.Object obj)  
    java.lang.String getWriteableName()  
    int hashCode()  
    protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    protected boolean overrideBucketsPath()  
    static InferencePipelineAggregationBuilder parse​(java.lang.String pipelineAggregatorName, org.elasticsearch.common.xcontent.XContentParser parser)  
    void setInferenceConfig​(InferenceConfig inferenceConfig)  
    protected void validate​(org.elasticsearch.search.aggregations.PipelineAggregationBuilder.ValidationContext context)  

    Methods inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

    create, getType, setMetadata, toXContent, type, writeTo

    Methods inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

    getBucketsPaths, getName, rewrite, subAggregations, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

    • NAME

      public static java.lang.String NAME

    • MODEL_ID

      public static final org.elasticsearch.common.ParseField MODEL_ID

  • Constructor Details

    • InferencePipelineAggregationBuilder

      public InferencePipelineAggregationBuilder​(java.lang.String name, java.lang.String modelId, java.util.Map<java.lang.String,​java.lang.String> bucketsPath)

  • Method Details

    • parse

      public static InferencePipelineAggregationBuilder parse​(java.lang.String pipelineAggregatorName, org.elasticsearch.common.xcontent.XContentParser parser)

    • setInferenceConfig

      public void setInferenceConfig​(InferenceConfig inferenceConfig)

    • validate

      protected void validate​(org.elasticsearch.search.aggregations.PipelineAggregationBuilder.ValidationContext context)
      Specified by:
      validate in class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

    • doWriteTo

      protected void doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)
      Specified by:
      doWriteTo in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>

    • createInternal

      protected org.elasticsearch.search.aggregations.pipeline.PipelineAggregator createInternal​(java.util.Map<java.lang.String,​java.lang.Object> metaData)
      Specified by:
      createInternal in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>

    • overrideBucketsPath

      protected boolean overrideBucketsPath()
      Overrides:
      overrideBucketsPath in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>

    • internalXContent

      protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      internalXContent in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>
      Throws:
      java.io.IOException

    • getWriteableName

      public java.lang.String getWriteableName()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<InferencePipelineAggregationBuilder>