Class: OpenSearch::DSL::Search::Aggregations::Filter

Inherits:

Object

• Object
• OpenSearch::DSL::Search::Aggregations::Filter

Includes:

BaseAggregationComponent

Defined in:

lib/opensearch/dsl/search/aggregations/filter.rb

Overview

Defines a single bucket with documents matching the provided filter, usually to define scope for a nested aggregation

Examples:

search do
  aggregation :clicks_for_tag_one do
    filter terms: { tags: ['one'] } do
      aggregation :sum_clicks do
        sum field: 'clicks'
      end
    end
  end
end

See Also:

• http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-filters-aggregation.html

Method Summary

Methods included from BaseAggregationComponent

included