org.elasticsearch.search.aggregations.bucket.sampler.SamplerAggregationBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.15.1

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.search.aggregations.bucket.sampler;

import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder;

import java.io.IOException;

/**
 * Builder for the {@link Sampler} aggregation.
 */
public class SamplerAggregationBuilder extends ValuesSourceAggregationBuilder {

    private int shardSize = SamplerParser.DEFAULT_SHARD_SAMPLE_SIZE;

    int maxDocsPerValue = SamplerParser.MAX_DOCS_PER_VALUE_DEFAULT;
    String executionHint = null;

    /**
     * Sole constructor.
     */
    public SamplerAggregationBuilder(String name) {
        super(name, InternalSampler.TYPE.name());
    }

    /**
     * Set the max num docs to be returned from each shard.
     */
    public SamplerAggregationBuilder shardSize(int shardSize) {
        this.shardSize = shardSize;
        return this;
    }

    public SamplerAggregationBuilder maxDocsPerValue(int maxDocsPerValue) {
        this.maxDocsPerValue = maxDocsPerValue;
        return this;
    }

    public SamplerAggregationBuilder executionHint(String executionHint) {
        this.executionHint = executionHint;
        return this;
    }

    @Override
    protected XContentBuilder doInternalXContent(XContentBuilder builder, Params params) throws IOException {
        // builder.startObject();
        if (shardSize != SamplerParser.DEFAULT_SHARD_SAMPLE_SIZE) {
            builder.field(SamplerParser.SHARD_SIZE_FIELD.getPreferredName(), shardSize);
        }

        if (maxDocsPerValue != SamplerParser.MAX_DOCS_PER_VALUE_DEFAULT) {
            builder.field(SamplerParser.MAX_DOCS_PER_VALUE_FIELD.getPreferredName(), maxDocsPerValue);
        }
        if (executionHint != null) {
            builder.field(SamplerParser.EXECUTION_HINT_FIELD.getPreferredName(), executionHint);
        }

        return builder;
    }


}