Class: OpenSearch::DSL::Search::Aggregations::BucketSelector

Inherits:

Object

Object
OpenSearch::DSL::Search::Aggregations::BucketSelector

show all

Includes:: BaseAggregationComponent

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

Overview

A parent pipeline aggregation which executes a script which determines whether the current bucket will be retained in the parent multi-bucket aggregation.

Examples:

Passing the options as a Hash


aggregation :sales_bucket_filter do
  bucket_selector buckets_path: { totalSales: 'total_sales' }, script: 'totalSales <= 50'
end

Passing the options as a block


aggregation :sales_bucket_filter do
  bucket_selector do
    buckets_path totalSales: 'total_sales'
    script 'totalSales <= 50'
  end
end

Method Summary

Methods included from BaseAggregationComponent

included