com.sksamuel.elastic4s.api.AggregationApi.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elastic4s-core_3 Show documentation
elastic4s-core
The newest version!
package com.sksamuel.elastic4s.api

import com.sksamuel.elastic4s.requests.searches.GeoPoint
import com.sksamuel.elastic4s.requests.searches.aggs.{AdjacencyMatrixAggregation, AutoDateHistogramAggregation, AvgAggregation, CardinalityAggregation, ChildrenAggregation, DateHistogramAggregation, DateRangeAggregation, ExtendedStatsAggregation, FilterAggregation, FiltersAggregation, GeoBoundsAggregation, GeoCentroidAggregation, GeoDistanceAggregation, GeoHashGridAggregation, GeoTileGridAggregation, GlobalAggregation, HistogramAggregation, IpRangeAggregation, KeyedFiltersAggregation, MaxAggregation, MinAggregation, MissingAggregation, MultiTermsAggregation, NestedAggregation, PercentileRanksAggregation, PercentilesAggregation, RangeAggregation, ReverseNestedAggregation, SamplerAggregation, ScriptedMetricAggregation, SigTermsAggregation, StatsAggregation, SumAggregation, TermsAggregation, TopHitsAggregation, TopMetricsAggregation, ValueCountAggregation, VariableWidthAggregation, WeightedAvgAggregation, WeightedAvgField}
import com.sksamuel.elastic4s.requests.searches.queries.Query
import com.sksamuel.elastic4s.ext.OptionImplicits._

trait AggregationApi {

  def adjacencyMatrixAgg(name: String, filters: Iterable[(String, Query)]): AdjacencyMatrixAggregation =
    AdjacencyMatrixAggregation(name, filters)

  @deprecated("use avgAgg", "7.7")
  def avgAggregation(name: String): AvgAggregation = AvgAggregation(name)
  def avgAgg(name: String, field: String): AvgAggregation = AvgAggregation(name).field(field)

  @deprecated("use cardinalityAgg", "7.7")
  def cardinalityAggregation(name: String): CardinalityAggregation = CardinalityAggregation(name)
  def cardinalityAgg(name: String, field: String): CardinalityAggregation =
    CardinalityAggregation(name).field(field)

  def childrenAggregation(name: String, childType: String): ChildrenAggregation =
    ChildrenAggregation(name, childType)

  @deprecated("use dateHistogramAgg", "7.7")
  def dateHistogramAggregation(name: String): DateHistogramAggregation = DateHistogramAggregation(name)
  def dateHistogramAgg(name: String, field: String): DateHistogramAggregation = dateHistogramAggregation(name).field(field)

  def autoDateHistogramAgg(name: String, field: String): AutoDateHistogramAggregation = AutoDateHistogramAggregation(name, field)

  @deprecated("use dateRangeAgg", "7.7")
  def dateRangeAggregation(name: String): DateRangeAggregation = DateRangeAggregation(name)
  def dateRangeAgg(name: String, field: String): DateRangeAggregation = dateRangeAggregation(name).field(field)

  @deprecated("use extendedStatsAgg", "7.7")
  def extendedStatsAggregation(name: String): ExtendedStatsAggregation = ExtendedStatsAggregation(name)
  def extendedStatsAgg(name: String, field: String): ExtendedStatsAggregation = ExtendedStatsAggregation(name, field = field.some)

  @deprecated("use filterAgg", "7.7")
  def filterAggregation(name: String) = new FilterAggregationExpectsQuery(name)
  class FilterAggregationExpectsQuery(name: String) {
    def query(query: Query): FilterAggregation = FilterAggregation(name, query)
  }
  def filterAgg(name: String, query: Query): FilterAggregation = FilterAggregation(name, query)

  def filtersAggregation(name: String) = new FiltersAggregationExpectsQueries(name)
  class FiltersAggregationExpectsQueries(name: String) {
    def queries(first: Query, rest: Query*): FiltersAggregation = queries(first +: rest)
    def queries(queries: Iterable[Query]): FiltersAggregation =
      FiltersAggregation(name, queries)
    def queries(first: (String, Query), rest: (String, Query)*): KeyedFiltersAggregation =
      queries(first +: rest)
    def queries(queries: Iterable[(String, Query)]): KeyedFiltersAggregation =
      KeyedFiltersAggregation(name, queries)
  }
  def geoBoundsAggregation(name: String): GeoBoundsAggregation = GeoBoundsAggregation(name)

  def geoDistanceAggregation(name: String) = new GeoDistanceAggregationExpectsOrigin(name)
  class GeoDistanceAggregationExpectsOrigin(name: String) {
    def origin(lat: Double, long: Double): GeoDistanceAggregation = origin(GeoPoint(lat, long))
    def origin(origin: GeoPoint): GeoDistanceAggregation = GeoDistanceAggregation(name, origin)
  }

  def geoHashGridAggregation(name: String): GeoHashGridAggregation = GeoHashGridAggregation(name)
  def geoTileGridAggregation(name: String): GeoTileGridAggregation = GeoTileGridAggregation(name)
  def geoCentroidAggregation(name: String): GeoCentroidAggregation = GeoCentroidAggregation(name)
  def globalAggregation(name: String): GlobalAggregation = GlobalAggregation(name)
  def histogramAggregation(name: String): HistogramAggregation = HistogramAggregation(name)
  def ipRangeAggregation(name: String): IpRangeAggregation = IpRangeAggregation(name)

  @deprecated("use maxAgg", "7.7")
  def maxAggregation(name: String): MaxAggregation = MaxAggregation(name)
  def maxAgg(name: String): MaxAggregation = MaxAggregation(name)
  def maxAgg(name: String, field: String): MaxAggregation = MaxAggregation(name).field(field)

  @deprecated("use minAgg", "7.7")
  def minAggregation(name: String): MinAggregation = MinAggregation(name)
  def minAgg(name: String, field: String): MinAggregation = MinAggregation(name).field(field)

  @deprecated("use missingAgg", "7.7")
  def missingAggregation(name: String): MissingAggregation = MissingAggregation(name)
  def missingAgg(name: String, field: String): MissingAggregation = MissingAggregation(name).field(field)

  def multiTermsAgg(name: String, terms: MultiTermsAggregation.Term*): MultiTermsAggregation = MultiTermsAggregation(name).terms(terms)

  def nestedAggregation(name: String, path: String): NestedAggregation = NestedAggregation(name, path)

  @deprecated("use percentilesAgg", "7.7")
  def percentilesAggregation(name: String): PercentilesAggregation = PercentilesAggregation(name)
  def percentilesAgg(name: String, field: String): PercentilesAggregation = PercentilesAggregation(name).field(field)

  def percentileRanksAggregation(name: String): PercentileRanksAggregation = PercentileRanksAggregation(name)

  def rangeAgg(name: String, field: String): RangeAggregation = RangeAggregation(name).field(field)

  @deprecated("use rangeAgg", "7.7")
  def rangeAggregation(name: String): RangeAggregation = RangeAggregation(name)

  def reverseNestedAggregation(name: String): ReverseNestedAggregation =
    ReverseNestedAggregation(name)

  def scriptedMetricAggregation(name: String): ScriptedMetricAggregation =
    ScriptedMetricAggregation(name)

  def sigTermsAggregation(name: String): SigTermsAggregation = SigTermsAggregation(name)
  def statsAggregation(name: String): StatsAggregation = StatsAggregation(name)

  @deprecated("use sumAgg", "7.7")
  def sumAggregation(name: String): SumAggregation = SumAggregation(name)
  def sumAgg(name: String, field: String): SumAggregation = SumAggregation(name).field(field)

  @deprecated("use termsAgg", "7.7")
  def termsAggregation(name: String): TermsAggregation = TermsAggregation(name)
  def termsAgg(name: String, field: String): TermsAggregation = TermsAggregation(name).field(field)

  @deprecated("use topHitsAgg", "7.7")
  def topHitsAggregation(name: String): TopHitsAggregation = TopHitsAggregation(name)
  def topHitsAgg(name: String): TopHitsAggregation = TopHitsAggregation(name)

  def topMetricsAgg(name: String): TopMetricsAggregation = TopMetricsAggregation(name)

  @deprecated("use valueCountAgg", "7.7")
  def valueCountAggregation(name: String): ValueCountAggregation = ValueCountAggregation(name)
  def valueCountAgg(name: String, field: String): ValueCountAggregation =
    ValueCountAggregation(name).field(field)

  def weightedAvgAgg(name: String, value: WeightedAvgField, weight: WeightedAvgField): WeightedAvgAggregation = WeightedAvgAggregation(name).value(value).weight(weight)

  @deprecated("use samplerAgg", "7.7")
  def samplerAggregation(name: String): SamplerAggregation = SamplerAggregation(name)
  def samplerAgg(name: String): SamplerAggregation = SamplerAggregation(name)

  def variableWidthHistogramAgg(name: String, field: String): VariableWidthAggregation =
    VariableWidthAggregation(name, field)
}