org.elasticsearch.search.aggregations.bucket.geogrid.GeoGrid Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* 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.geogrid;
import org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation;
import java.util.List;
/**
* A geo-grid aggregation. Defines multiple buckets, each representing a cell in a geo-grid of a specific
* precision.
*/
public interface GeoGrid extends MultiBucketsAggregation {
/**
* A bucket that is associated with a geo-grid cell. The key of the bucket is
* the {@link InternalGeoGridBucket#getKeyAsString()} of the cell
*/
interface Bucket extends MultiBucketsAggregation.Bucket {
}
/**
* @return The buckets of this aggregation (each bucket representing a geo-grid cell)
*/
@Override
List getBuckets();
}