All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.arakelian.elastic.model.aggs.bucket.TermsAggregation Maven / Gradle / Ivy

    /*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 com.arakelian.elastic.model.aggs.bucket;

import java.util.List;

import org.immutables.value.Value;

import com.arakelian.core.feature.Nullable;
import com.arakelian.elastic.model.aggs.Aggregation;
import com.arakelian.elastic.model.aggs.BucketAggregation;
import com.arakelian.elastic.model.aggs.ValuesSourceAggregation;
import com.arakelian.elastic.model.enums.CollectMode;
import com.arakelian.elastic.model.enums.ExecutionHint;
import com.arakelian.elastic.search.AggregationVisitor;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.collect.ImmutableList;

/**
 * @see Terms
 *      Aggregation
 * @see TermsAggregationBuilder.java
 */
@Value.Immutable(copy = false)
@JsonSerialize(as = ImmutableTermsAggregation.class)
@JsonDeserialize(builder = ImmutableTermsAggregation.Builder.class)
@JsonTypeName(Aggregation.TERMS_AGGREGATION)
public interface TermsAggregation extends BucketAggregation, ValuesSourceAggregation {
    @Nullable
    public CollectMode getCollectMode();

    @Nullable
    public String getExclude();

    @Value.Default
    public default List getExcludeValues() {
        return ImmutableList.of();
    }

    /**
     * Returns the mechanism by which terms aggregation is executed.
     *
     * @return the mechanism by which terms aggregation is executed.
     */
    @Nullable
    public ExecutionHint getExecutionHint();

    @Nullable
    public String getInclude();

    @Value.Default
    public default List getIncludeValues() {
        return ImmutableList.of();
    }

    /**
     * Returns the minimum number of hits required before returning a term.
     *
     * @return the minimum number of hits required before returning a term.
     */
    @Nullable
    public Long getMinDocCount();

    /**
     * Returns the bucket order.
     *
     * @return the bucket order
     *
     * @see InternalOrder.java
     */
    @Value.Default
    public default List getOrder() {
        return ImmutableList.of();
    }

    /**
     * Returns the minimum number of hits required on a local shard before a term is returned.
     *
     * @return the minimum number of hits required on a local shard before a term is returned.
     */
    @Nullable
    public Long getShardMinDocCount();

    /**
     * Returns how many terms the coordinating node will request from each shard. Once all the
     * shards responded, the coordinating node will then reduce them to a final result which will be
     * based on the size parameter - this way, one can increase the accuracy of the returned terms
     * and avoid the overhead of streaming a big list of buckets back to the client.
     *
     * @return the number of terms the coordinating node will request from each shard.
     */
    @Nullable
    public Long getShardSize();

    /**
     * Returns how many term buckets should be returned out of the overall terms list. By default,
     * the node coordinating the search process will request each shard to provide its own top size
     * term buckets and once all shards respond, it will reduce the results to the final list that
     * will then be returned to the client.
     *
     * @return how many term buckets should be returned out of the overall terms list.
     */
    @Nullable
    public Integer getSize();

    @Nullable
    public Boolean isShowTermDocCountError();

    @Override
    default void accept(final AggregationVisitor visitor) {
        if (!visitor.enter(this)) {
            return;
        }
        try {
            if (visitor.enterTerms(this)) {
                visitor.leaveTerms(this);
            }
        } finally {
            visitor.leave(this);
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy