Class: OpenSearch::DSL::Search::Aggregations::MaxBucket

Inherits:

Object

Object
OpenSearch::DSL::Search::Aggregations::MaxBucket

show all

Includes:: BaseAggregationComponent

Defined in:: lib/opensearch/dsl/search/aggregations/pipeline/max_bucket.rb

Overview

A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).

Examples:

Passing the options as a Hash


aggregation :max_monthly_sales do
  max_bucket buckets_path: 'sales_per_month>sales'
end

Passing the options as a block


aggregation :max_monthly_sales do
  max_bucket do
    buckets_path 'sales_per_month>sales'
  end
end

Method Summary

Methods included from BaseAggregationComponent

included